| Package | hl7.fhir.us.core |
| Type | CapabilityStatement |
| Id | Id |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/us/core/https://build.fhir.org/ig/HL7/US-Core/CapabilityStatement-us-core-client.html |
| Url | http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client |
| Version | 8.0.0-ballot |
| Status | active |
| Date | 2024-11-22T13:17:10.631193-08:00 |
| Name | UsCoreClientCapabilityStatement |
| Title | US Core Client CapabilityStatement |
| Experimental | False |
| Realm | us |
| Authority | hl7 |
| Description | This Section describes the expected capabilities of the US Core Client which is responsible for creating and initiating the queries for information about an individual patient. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Core Servers are defined in the [Conformance Requirements for Server](CapabilityStatement-us-core-server.html). US Core Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements. |
| Copyright | Used by permission of HL7 International, all rights reserved Creative Commons License |
| Kind | requirements |
Note: links and images are rebased to the (stated) source
The US Core Client SHALL:
NOTE: US Core SearchParameters referenced in this CapabilityStatement that are derived from standard FHIR SearchParameters are only defined to document Server and Client expectations. They specify additional expectations for the following SearchParameter elements:
FHIR
multipleAndmultipleOrcomparatormodifierchainThey SHALL NOT be interpreted as search parameters for search. Servers and Clients SHOULD use the standard FHIR SearchParameters.
Security:
Summary of System Wide Interactions
transaction interaction.batch interaction.search-system interaction.history-system interaction.| Resource Type | Supported Profiles | Supported Searches | Supported _includes | Supported _revincludes | Supported Operations |
|---|---|---|---|---|---|
| AllergyIntolerance | US Core AllergyIntolerance Profile | clinical-status, patient patient+clinical-status | - | Provenance:target | - |
| CarePlan | US Core CarePlan Profile | category, date, patient, status patient+category+status+date, patient+category+status, patient+category, patient+category+date | - | Provenance:target | - |
| CareTeam | US Core CareTeam Profile | patient, role, status patient+status, patient+role | CareTeam:participant:PractitionerRole, CareTeam:participant:Practitioner, CareTeam:participant:Patient, CareTeam:participant:RelatedPerson | Provenance:target | - |
| Condition | US Core Condition Encounter Diagnosis Profile, US Core Condition Problems and Health Concerns Profile | abatement-date, asserted-date, category, clinical-status, code, encounter, onset-date, patient, recorded-date, _lastUpdated patient+onset-date, patient+_lastUpdated, patient+category+encounter, patient+category+clinical-status, patient+recorded-date, patient+asserted-date, patient+abatement-date, patient+code, patient+category, patient+clinical-status | - | Provenance:target | - |
| Coverage | US Core Coverage Profile | patient | - | Provenance:target | - |
| Device | US Core Implantable Device Profile | patient, status, type patient+type, patient+status | - | Provenance:target | - |
| DiagnosticReport | US Core DiagnosticReport Profile for Report and Note exchange, US Core DiagnosticReport Profile for Laboratory Results Reporting | category, code, date, _lastUpdated, patient, status patient+status, patient+code+date, patient+category+date, patient+code, patient+category+_lastUpdated, patient+category | - | Provenance:target | - |
| DocumentReference | US Core DocumentReference Profile | _id, category, date, patient, period, status, type patient+status, patient+category+date, patient+type+period, patient+type, patient+category | - | Provenance:target | docref |
| Encounter | US Core Encounter Profile | _id, class, date, _lastUpdated, discharge-disposition, identifier, location, patient, status, type patient+status, patient+_lastUpdated, date+patient, patient+type, patient+location, patient+discharge-disposition, class+patient | - | Provenance:target | - |
| Endpoint | - | - | - | - | - |
| Goal | US Core Goal Profile | description, lifecycle-status, patient, target-date patient+target-date, patient+lifecycle-status, patient+description | - | Provenance:target | - |
| HealthcareService | - | - | - | - | - |
| Immunization | US Core Immunization Profile | date, patient, status patient+status, patient+date | - | Provenance:target | - |
| Location | US Core Location Profile | address, address-city, address-postalcode, address-state, name | - | - | - |
| Media | - | - | - | - | - |
| Medication | US Core Medication Profile | - | - | - | - |
| MedicationDispense | US Core MedicationDispense Profile | patient, status, type patient+status, patient+status+type | MedicationDispense:medication | Provenance:target | - |
| MedicationRequest | US Core MedicationRequest Profile | authoredon, encounter, intent, patient, status patient+intent+authoredon, patient+intent+status, patient+intent, patient+intent+encounter | MedicationRequest:medication | Provenance:target | - |
| Observation | US Core Laboratory Result Observation Profile, US Core Observation Pregnancy Status Profile, US Core Observation Pregnancy Intent Profile, US Core Observation Occupation Profile, US Core Respiratory Rate Profile, US Core Simple Observation Profile, US Core Treatment Intervention Preference Profile, US Core Care Experience Preference Profile, US Core Heart Rate Profile, US Core Body Temperature Profile, US Core Pediatric Weight for Height Observation Profile, US Core Pulse Oximetry Profile, US Core Smoking Status Observation Profile, US Core Observation Sexual Orientation Profile, US Core Head Circumference Profile, US Core Body Height Profile, US Core BMI Profile, US Core Observation Screening Assessment Profile, US Core Average Blood Pressure Profile, US Core Blood Pressure Profile, US Core Observation Clinical Result Profile, US Core Pediatric BMI for Age Observation Profile, US Core Pediatric Head Occipital Frontal Circumference Percentile Profile, US Core Body Weight Profile, US Core Vital Signs Profile | category, code, date, _lastUpdated, patient, status patient+code+date, patient+category+date, patient+code, patient+category+_lastUpdated, patient+category, patient+category+status | - | Provenance:target | - |
| Organization | US Core Organization Profile | address, name | - | - | - |
| Patient | US Core Patient Profile | _id, birthdate, death-date, family, gender, given, identifier, name family+gender, birthdate+name, death-date+family, gender+name, birthdate+family | - | Provenance:target | - |
| Practitioner | US Core Practitioner Profile | _id, identifier, name | - | - | - |
| PractitionerRole | US Core PractitionerRole Profile | practitioner, specialty | PractitionerRole:endpoint, PractitionerRole:practitioner | - | - |
| Procedure | US Core Procedure Profile | code, date, patient, status patient+status, patient+date, patient+code+date | - | Provenance:target | - |
| Provenance | US Core Provenance Profile | - | - | - | - |
| Questionnaire | SDC Base Questionnaire Profile | - | - | - | - |
| QuestionnaireResponse | US Core QuestionnaireResponse Profile | _id, authored, patient, questionnaire, status patient+status, patient+questionnaire, patient+authored | - | Provenance:target | - |
| RelatedPerson | US Core RelatedPerson Profile | _id, name, patient patient+name | - | Provenance:target | - |
| ServiceRequest | US Core ServiceRequest Profile | _id, authored, category, code, patient, status patient+status, patient+code+authored, patient+code, patient+category+authored, patient+category | - | Provenance:target | - |
| Specimen | US Core Specimen Profile | _id, patient | - | - | - |
| ValueSet | - | - | - | - | expand |
Conformance Expectation: SHOULD
Supported Profiles:
Profile Interaction Summary:
search-type, read.vread, history-instance.create, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/AllergyIntolerance/[id] GET [base]/AllergyIntolerance?[parameter=value]&_revinclude=Provenance:target Search Parameter Summary:
| Conformance | Parameter | Type |
|---|---|---|
| SHALL | patient | reference |
Search Parameter Combination Summary:
| Conformance | Parameter Combination | Types |
|---|---|---|
| SHOULD | patient+ clinical-status | reference+token |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
- Additional considerations for systems aligning with HL7 Consolidated (C-CDA) Care Plan requirements:
- US Core Goal SHOULD be present in CarePlan.goal
- US Core Condition SHOULD be present in CarePlan.addresses
- Assessment and Plan MAY be included as narrative text
Supported Profiles:
Profile Interaction Summary:
search-type, read.vread, history-instance.create, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/CarePlan/[id] GET [base]/CarePlan?[parameter=value]&_revinclude=Provenance:target Search Parameter Combination Summary:
| Conformance | Parameter Combination | Types |
|---|---|---|
| SHOULD | patient+ category+ status+ date | reference+token+token+date |
| SHOULD | patient+ category+ status | reference+token+token |
| SHALL | patient+ category | reference+token |
| SHOULD | patient+ category+ date | reference+token+date |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
- In order to access care team member's names, identifiers, locations, and contact information, the CareTeam profile supports several types of care team participants. They are represented as references to other profiles and include the following four profiles which are marked as must support:
- US Core Practitioner Profile
- US Core PractitionerRole Profile
- US Core Patient Profile
- US Core RelatedPerson Profile
- Although both US Core Practitioner Profile and US Core PractitionerRole are must support, the server system is not required to support both types of references, but SHALL support at least one of them.
- The client application SHALL support all four profile references.
- Bacause the US Core PractitionerRole Profile supplies the provider's location and contact information and a reference to the Practitioner, server systems SHOULD reference it instead of the US Core Practitioner Profile.
- Servers that support only US Core Practitioner Profile and do not support the US Core PractitionerRole Profile SHALL provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource.
Supported Profiles:
Profile Interaction Summary:
search-type, read.vread, history-instance.create, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/CareTeam/[id] GET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:PractitionerRole GET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:Practitioner GET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:Patient GET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:RelatedPerson GET [base]/CareTeam?[parameter=value]&_revinclude=Provenance:target Search Parameter Summary:
| Conformance | Parameter | Type |
|---|---|---|
| SHOULD | role | token |
Search Parameter Combination Summary:
| Conformance | Parameter Combination | Types |
|---|---|---|
| SHALL | patient+ status | reference+token |
| SHOULD | patient+ role | reference+token |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
- Clients SHALL support at least one Condition Profile
- For Encounter Diagnosis use the US Core Condition Encounter Diagnosis Profile.
- When
Condition.categoryis "encounter-diagnosis" the encounter, SHOULD be referenced inCondition.encounter.- For Problems and Health Concerns use the US Core Condition Problems and Health Concerns Profile.
- When
Condition.categoryis a "problems-list-item", the `Condition.clinicalStatus SHOULD NOT be unknown.- There is no single element in Condition that represents the date of diagnosis. It may be the assertedDate Extension,
Condition.onsetDateTime, orCondition.recordedDate.
- Although all three are marked as must support, the server is not required to support all.
- A server SHALL support
Condition.recordedDate.- A server SHALL support at least one of the assertedDate Extension and
Condition.onsetDateTime. A server may support both, which means they support all three elements.- The client application SHALL support all three elements.
Supported Profiles:
Profile Interaction Summary:
search-type, read.vread, history-instance.create, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/Condition/[id] GET [base]/Condition?[parameter=value]&_revinclude=Provenance:target Search Parameter Summary:
| Conformance | Parameter | Type |
|---|---|---|
| SHALL | patient | reference |
Search Parameter Combination Summary:
| Conformance | Parameter Combination | Types |
|---|---|---|
| SHOULD | patient+ onset-date | reference+date |
| SHOULD | patient+ _lastUpdated | reference+date |
| SHOULD | patient+ category+ encounter | reference+token+reference |
| SHOULD | patient+ category+ clinical-status | reference+token+token |
| SHOULD | patient+ recorded-date | reference+date |
| SHOULD | patient+ asserted-date | reference+date |
| SHOULD | patient+ abatement-date | reference+date |
| SHOULD | patient+ code | reference+token |
| SHALL | patient+ category | reference+token |
| SHOULD | patient+ clinical-status | reference+token |
Search Parameter Requirements (When Used Alone or in Combination):
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
A server SHALL document the types of changes that can be detected using this parameter.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
Conformance Expectation: SHOULD
Supported Profiles:
Profile Interaction Summary:
search-type, read.vread, history-instance.create, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/Coverage/[id] GET [base]/Coverage?[parameter=value]&_revinclude=Provenance:target Search Parameter Summary:
| Conformance | Parameter | Type |
|---|---|---|
| SHALL | patient | reference |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
Implantable medical devices that have UDI information SHALL represent the UDI code in
Device.udiCarrier.carrierHRF.
- All of the five UDI-PI elements that are present in the UDI code SHALL be represented in the corresponding US Core Implantable Device Profile element.
UDI may not be present in all scenarios such as historical implantable devices, patient reported implant information, payer reported devices, or improperly documented implants. If UDI is not present and the manufacturer and/or model number information is available, they SHOULD be included to support historical reports of implantable medical devices as follows:
manufacturer ->
Device.manufacturer
model ->Device.modelServers SHOULD support query by Device.type to allow clients to request the patient's devices by a specific type. Note: The Device.type is too granular to differentiate implantable vs. non-implantable devices.
Supported Profiles:
Profile Interaction Summary:
search-type, read.vread, history-instance.create, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/Device/[id] GET [base]/Device?[parameter=value]&_revinclude=Provenance:target Search Parameter Summary:
| Conformance | Parameter | Type |
|---|---|---|
| SHALL | patient | reference |
Search Parameter Combination Summary:
| Conformance | Parameter Combination | Types |
|---|---|---|
| SHOULD | patient+ type | reference+token |
| SHOULD | patient+ status | reference+token |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
- Clients SHALL support at least one DiagnosticReport Profile
- When
DiagnosticReport.categoryis "LAB" the encounter, Updates to Meta.lastUpdated SHOULD reflect:
- New laboratory reports
- Changes in the status of laboratory reports including events that trigger the same status (e.g., amended → amended).
Supported Profiles:
Profile Interaction Summary:
create†, search-type, read.vread, history-instance.update, patch, delete, history-type.create†This conformance expectation applies only to the US Core DiagnosticReport Profile for Report and Note exchange profile. The conformance expectation for the US Core DiagnosticReport Profile for Laboratory Results Reporting is MAY.
Fetch and Search Criteria:
GET [base]/DiagnosticReport/[id] GET [base]/DiagnosticReport?[parameter=value]&_revinclude=Provenance:target Search Parameter Summary:
| Conformance | Parameter | Type |
|---|---|---|
| SHALL | patient | reference |
Search Parameter Combination Summary:
| Conformance | Parameter Combination | Types |
|---|---|---|
| SHOULD | patient+ status | reference+token |
| SHOULD | patient+ code+ date | reference+token+date |
| SHALL | patient+ category+ date | reference+token+date |
| SHALL | patient+ code | reference+token |
| SHOULD | patient+ category+ _lastUpdated | reference+token+date |
| SHALL | patient+ category | reference+token |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
A server SHALL document the types of changes that can be detected using this parameter.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
- The
DocumentReference.typebinding SHALL support at a minimum the 5 Common Clinical Notes and may extend to the full US Core DocumentReference Type Value Set- The DocumentReference resources can represent the referenced content using either an address where the document can be retrieved using
DocumentReference.attachment.urlor the content as inline base64 encoded data usingDocumentReference.attachment.data.
- Although both are marked as must support, the server system is not required to support an address, and inline base64 encoded data, but SHALL support at least one of these elements.
- The client application SHALL support both elements.
- The
content.urlmay refer to a FHIR Binary Resource (i.e. [base]/Binary/[id]), FHIR Document Bundle (i.e [base]/Bundle/[id] or another endpoint.
- If the endpoint is outside the FHIR base URL, it SHOULD NOT require additional authorization to access.
- If there are multiple
DocumentReference.contentelement repetitions, these SHALL all represent the same document in different format or attachment metadata. The content element SHALL NOT contain different versions of the same content. For version handling use multiple DocumentReferences withDocumentReference.relatesTo- Every DocumentReference must have a responsible Organization. The organization responsible for the DocumentReference SHALL be present either in
DocumentReference.custodianor accessible in the Provenance resource targeting the DocumentReference usingProvenance.agent.whoorProvenance.agent.onBehalfOf.
Supported Profiles:
Profile Interaction Summary:
create, search-type, read.vread, history-instance.update, patch, delete, history-type.Operation Summary:
A client SHOULD be capable of transacting a $docref operation and capable of receiving at least a reference to a generated CCD document, and MAY be able to receive other document types, if available. SHOULD be capable of receiving documents as included resources in response to the operation.
GET [base]/DocumentReference/$docref?patient=[id]
Fetch and Search Criteria:
GET [base]/DocumentReference/[id] GET [base]/DocumentReference?[parameter=value]&_revinclude=Provenance:target Search Parameter Summary:
| Conformance | Parameter | Type |
|---|---|---|
| SHALL | _id | token |
| SHALL | patient | reference |
Search Parameter Combination Summary:
| Conformance | Parameter Combination | Types |
|---|---|---|
| SHOULD | patient+ status | reference+token |
| SHALL | patient+ category+ date | reference+token+date |
| SHOULD | patient+ type+ period | reference+token+date |
| SHALL | patient+ type | reference+token |
| SHALL | patient+ category | reference+token |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
The Encounter resource can represent a reason using either a code with
Encounter.reasonCode, or a reference withEncounter.reasonReferenceto Condition or other resource.
- Although both are marked as must support, the server systems are not required to support both a code and a reference, but they SHALL support at least one of these elements.
- The client application SHALL support both elements.
- if
Encounter.reasonReferencereferences an Observation, it SHOULD conform to a US Core Observation if applicable. (for example, a laboratory result should conform to the US Core Laboratory Result Observation Profile)The location address can be represented by either by the Location referenced by
Encounter.location.locationor indirectly through the Organization referenced byEncounter.serviceProvider.
- Although both are marked as must support, the server systems are not required to support both
Encounter.location.locationandEncounter.serviceProvider, but they SHALL support at least one of these elements.- The client application SHALL support both elements.
If the event facility/location differs from the
Encounter.location, systems SHOULD reference it directly:
Supported Profiles:
Profile Interaction Summary:
search-type, read.vread, history-instance.create, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/Encounter/[id] GET [base]/Encounter?[parameter=value]&_revinclude=Provenance:target Search Parameter Summary:
| Conformance | Parameter | Type |
|---|---|---|
| SHALL | _id | token |
| SHOULD | identifier | token |
| SHALL | patient | reference |
Search Parameter Combination Summary:
| Conformance | Parameter Combination | Types |
|---|---|---|
| SHOULD | patient+ status | reference+token |
| SHOULD | patient+ _lastUpdated | reference+date |
| SHALL | date+ patient | date+reference |
| SHOULD | patient+ type | reference+token |
| SHOULD | patient+ location | reference+reference |
| SHOULD | patient+ discharge-disposition | reference+token |
| SHOULD | class+ patient | token+reference |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
A server SHALL document the types of changes that can be detected using this parameter.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
The Media Resource is a Must Support referenced resource when using the US Core PractitionerRole Profile.
Profile Interaction Summary:
read, vread.create, search-type, update, patch, delete, history-instance, history-type.Fetch and Search Criteria:
GET [base]/Endpoint/[id] Conformance Expectation: SHOULD
Resource Specific Documentation:
- Although both
Goal.startDateandGoal.target.dueDateare marked as must support, the server system is not required to support both, but SHALL support at least one of these elements. The client application SHALL support both elements.
Supported Profiles:
Profile Interaction Summary:
search-type, read.vread, history-instance.create, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/Goal/[id] GET [base]/Goal?[parameter=value]&_revinclude=Provenance:target Search Parameter Summary:
| Conformance | Parameter | Type |
|---|---|---|
| SHALL | patient | reference |
Search Parameter Combination Summary:
| Conformance | Parameter Combination | Types |
|---|---|---|
| SHOULD | patient+ target-date | reference+date |
| SHOULD | patient+ lifecycle-status | reference+token |
| SHOULD | patient+ description | reference+token |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
A client SHALL provide a value precise to the day.
A server SHALL support a value a value precise to the day.
Conformance Expectation: MAY
Resource Specific Documentation:
The HealthcareService Resource is a referenced resource when using the US Core PracitionRole Profile and subject to constraint us-core-13: "SHALL have a practitioner, an organization, a healthcare service, or a location."
Profile Interaction Summary:
read, vread.create, search-type, update, patch, delete, history-instance, history-type.Fetch and Search Criteria:
GET [base]/HealthcareService/[id] Conformance Expectation: SHOULD
Resource Specific Documentation:
- Based upon the ONC U.S. Core Data for Interoperability (USCDI) requirements, CVX vaccine codes are required and the NDC vaccine codes SHOULD be supported as translations to them.
Supported Profiles:
Profile Interaction Summary:
search-type, read.vread, history-instance.create, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/Immunization/[id] GET [base]/Immunization?[parameter=value]&_revinclude=Provenance:target Search Parameter Summary:
| Conformance | Parameter | Type |
|---|---|---|
| SHALL | patient | reference |
Search Parameter Combination Summary:
| Conformance | Parameter Combination | Types |
|---|---|---|
| SHOULD | patient+ status | reference+token |
| SHOULD | patient+ date | reference+date |
Search Parameter Requirements (When Used Alone or in Combination):
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
- Systems SHOULD follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for
Location.address.lineandLocation.address.city.
Supported Profiles:
Profile Interaction Summary:
search-type, read.vread, history-instance.create, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/Location/[id] Search Parameter Summary:
| Conformance | Parameter | Type |
|---|---|---|
| SHALL | address | string |
| SHOULD | address-city | string |
| SHOULD | address-postalcode | string |
| SHOULD | address-state | string |
| SHALL | name | string |
Conformance Expectation: SHOULD
Resource Specific Documentation:
The Media Resource is a Must Support referenced resource when using the US Core DiagnosticReport Profile for Report and Note Exchange.
Profile Interaction Summary:
read, vread.create, search-type, update, patch, delete, history-instance, history-type.Fetch and Search Criteria:
GET [base]/Media/[id] Conformance Expectation: SHOULD
Resource Specific Documentation:
- The MedicationRequest resource can represent a medication, using an external reference to a Medication resource. If an external Medication Resource is used in a MedicationRequest, then the READ SHALL be supported.
Supported Profiles:
Profile Interaction Summary:
read.vread, history-instance.create, search-type, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/Medication/[id] Conformance Expectation: SHOULD
Resource Specific Documentation:
- The MedicationDispense resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be contained or an external resource. The server application MAY choose any one way or more than one method, but if an external reference to Medication is used, the server SHALL support the _include` parameter for searching this element. The client application must support all methods.
- For example, A server SHALL be capable of returning dispense records for all medications for a patient using one of or both:
GET /MedicationDispense?patient=[id]GET /MedicationDispense?patient=[id]&_include=MedicationDispense:medication
Supported Profiles:
Profile Interaction Summary:
search-type, read.vread, history-instance.create, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/MedicationDispense/[id] GET [base]/MedicationDispense?[parameter=value]&_include=MedicationDispense:medication GET [base]/MedicationDispense?[parameter=value]&_revinclude=Provenance:target Search Parameter Summary:
| Conformance | Parameter | Type |
|---|---|---|
| SHALL | patient | reference |
Search Parameter Combination Summary:
| Conformance | Parameter Combination | Types |
|---|---|---|
| SHOULD | patient+ status | reference+token |
| SHOULD | patient+ status+ type | reference+token+token |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
The MedicationRequest resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be contained or an external resource. The server application MAY choose any one way or more than one method, but if an external reference to Medication is used, the server SHALL support the _include` parameter for searching this element. The client application must support all methods.
- For example, A server SHALL be capable of returning all medications for a patient using one of or both:
GET /MedicationRequest?patient=[id]GET /MedicationRequest?patient=[id]&_include=MedicationRequest:medicationThe MedicationRequest resource can represent that information is from a secondary source using either a boolean flag or reference in
MedicationRequest.reportedBoolean, or a reference usingMedicationRequest.reportedReferenceto Practitioner or other resource.
- Although both are marked as must support, the server systems are not required to support both a boolean and a reference, but SHALL choose to support at least one of these elements.
- The client application SHALL support both elements.
When recording “self-prescribed” medication, requester SHOULD be used to indicate the Patient or RelatedPerson as the prescriber. (See the Medication List section for guidance on accessing a patient medications including over the counter (OTC) medication and other substances taken for medical and recreational use.)
The MedicationRequest resource can communicate the reason or indication for treatment using either a code in MedicationRequest.reasonCode or a reference using MedicationRequest.reasonReference.
Although both
MedicationRequest.reasonCodeandMedicationRequest.reasonReferenceare marked as Additional USCDI Requirements. The certifying server system is not required to support both but SHALL support at least one of these elements. The certifying client application SHALL support both elements.
- when using MedicationRequest.reasonReference:
- Servers SHALL support at least one target resource in
MedicationRequest.reasonReference. Clients SHALL support all target resources.- The referenced resources SHOULD be a US Core Profile as documented in Referencing US Core Profiles.
Supported Profiles:
Profile Interaction Summary:
search-type, read.vread, history-instance.create, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/MedicationRequest/[id] GET [base]/MedicationRequest?[parameter=value]&_include=MedicationRequest:medication GET [base]/MedicationRequest?[parameter=value]&_revinclude=Provenance:target Search Parameter Combination Summary:
| Conformance | Parameter Combination | Types |
|---|---|---|
| SHOULD | patient+ intent+ authoredon | reference+token+date |
| SHALL | patient+ intent+ status | reference+token+token |
| SHALL | patient+ intent | reference+token |
| SHOULD | patient+ intent+ encounter | reference+token+reference |
Search Parameter Requirements (When Used Alone or in Combination):
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
- Clients SHALL support at least one Observation Profile
- Systems SHOULD support
Observation.effectivePeriodto accurately represent tests that are collected over a period of time (for example, a 24-Hour Urine Collection test).- An Observation without a value, SHALL include a reason why the data is absent unless there are component observations, or references to other Observations that are grouped within it
- Systems that never provide an observation without a value are not required to support
Observation.dataAbsentReason- An
Observation.componentwithout a value, SHALL include a reason why the data is absent.
- Systems that never provide an component observation without a component value are not required to support
Observation.component.dataAbsentReason.- When
Observation.categoryis "laboratory" the encounter, Updates to Meta.lastUpdated SHOULD reflect:
- New laboratory results
- Changes in the status of laboratory results including events that trigger the same status (e.g., amended → amended).
Supported Profiles:
Profile Interaction Summary:
search-type, read.vread, history-instance.create, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/Observation/[id] GET [base]/Observation?[parameter=value]&_revinclude=Provenance:target Search Parameter Combination Summary:
| Conformance | Parameter Combination | Types |
|---|---|---|
| SHOULD | patient+ code+ date | reference+token+date |
| SHALL | patient+ category+ date | reference+token+date |
| SHALL | patient+ code | reference+token |
| SHOULD | patient+ category+ _lastUpdated | reference+token+date |
| SHALL | patient+ category | reference+token |
| SHOULD | patient+ category+ status | reference+token+token |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
A server SHALL document the types of changes that can be detected using this parameter.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
- Systems SHALL support National Provider Identifier (NPI) for organizations and SHOULD support Clinical Laboratory Improvement Amendments (CLIA) identifiers for
Organization.Identifier.- Systems SHOULD follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for
Organization.address.lineandOrganization.address.city.
Supported Profiles:
Profile Interaction Summary:
search-type, read.vread, history-instance.create, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/Organization/[id] Search Parameter Summary:
| Conformance | Parameter | Type |
|---|---|---|
| SHALL | address | string |
| SHALL | name | string |
Conformance Expectation: SHOULD
Resource Specific Documentation:
For ONC's USCDI requirements, each Patient must support the following additional elements. These elements are included in the formal definition of the profile. The patient examples include all of these elements.
- contact detail (e.g. a telephone number or an email address)
- a communication language
- a race
- an ethnicity
- a birth sex*
- previous name
- Previous name is represented by providing an end date in the
Patient.name.periodelement for a previous name.- suffix
- Suffix is represented using the
Patient.name.suffixelement.The Patient's Social Security Numbers SHOULD NOT be used as a patient identifier in
Patient.identifier.value.Although Patient.deceased[x] is marked as 헔헗헗헜헧헜헢헡헔헟 헨헦헖헗헜, certifying systems are not required to support both choices, but SHALL support at least
Patient.deceasedDateTime.Certifying systems SHALL and non-certifying systems SHOULD follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for
Patient.address.lineandPatient.address.cityfor new and updated records.
Supported Profiles:
Profile Interaction Summary:
search-type, read.vread, history-instance.create, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/Patient/[id] GET [base]/Patient?[parameter=value]&_revinclude=Provenance:target Search Parameter Summary:
| Conformance | Parameter | Type |
|---|---|---|
| SHALL | _id | token |
| SHALL | identifier | token |
| SHALL | name | string |
Search Parameter Combination Summary:
| Conformance | Parameter Combination | Types |
|---|---|---|
| SHOULD | family+ gender | string+token |
| SHALL | birthdate+ name | date+string |
| SHOULD | death-date+ family | date+string |
| SHALL | gender+ name | token+string |
| SHOULD | birthdate+ family | date+string |
Search Parameter Requirements (When Used Alone or in Combination):
A client SHALL provide a value precise to the day.
A server SHALL support a value a value precise to the day.
A client SHALL provide a value precise to the day.
A server SHALL support a value a value precise to the day.
A server SHALL support a value precise to the day.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
- Servers that support only US Core Practitioner Profile SHALL provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource.
- Although Practitioner.address is marked as Must Support, the server system is not required to support it if they support the US Core PractitionerRole Profile, but SHALL support it if they do not support the US Core PractitionerRole Profile. The client application SHALL support both.
- Systems SHOULD follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for
Practitioner.address.lineandPractitioner.address.city.
Supported Profiles:
Profile Interaction Summary:
search-type, read.vread, history-instance.create, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/Practitioner/[id] Search Parameter Summary:
| Conformance | Parameter | Type |
|---|---|---|
| SHOULD | _id | token |
| SHALL | identifier | token |
| SHALL | name | string |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
- Due to implementer feedback, some US Core Profiles reference the PractitionerRole resource instead of the US Core PractitionerRole Profile. However the US Core PractitionerRole Profile SHOULD be used as the default profile if referenced by another US Core profile.
Supported Profiles:
Profile Interaction Summary:
search-type, read.vread, history-instance.create, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/PractitionerRole/[id] GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:endpoint GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:practitioner Search Parameter Summary:
| Conformance | Parameter | Type |
|---|---|---|
| SHALL | practitioner | reference |
| SHALL | specialty | token |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
- Procedure codes can be taken from SNOMED-CT, CPT, HCPCS II, ICD-10-PCS, CDT. LOINC.
- Only LOINC concepts that reflect actual procedures SHOULD be used
- A procedure including an implantable device SHOULD use
Procedure.focalDevicewith a reference to the US Core Implantable Device Profile.- Servers and Clients SHALL support both US Core ServiceRequest and US Core Procedure Profiles for communicating the reason or justification for a referral as Additional USCDI Requirements. Typically, the reason or justification for a referral or consultation is communicated through
Procedure.basedOnlinking the Procedure to the US Core ServiceRequest Profile that includes eitherServiceRequest.reasonCodeorServiceRequest.reasonReference. When the Procedure does not have an associated ServiceRequest, it is communicated through the US Core Procedure Profile'sProcedure.reasonCodeorProcedure.reasonReference. Depending on the procedure being documented, a server will select the appropriate Profile to use.
- Although both
Procedure.reasonCodeandProcedure.reasonReferenceare marked as Additional USCDI Requirements. The certifying server system is not required to support both but SHALL support at least one of these elements. The certifying client application SHALL support both elements.
- when using
Procedure.reasonReference:
- Servers SHALL support at least one target resource in
Procedure.reasonReference. Clients SHALL support all target resources .- The referenced resources SHOULD be a US Core Profile.
Supported Profiles:
Profile Interaction Summary:
search-type, read.vread, history-instance.create, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/Procedure/[id] GET [base]/Procedure?[parameter=value]&_revinclude=Provenance:target Search Parameter Summary:
| Conformance | Parameter | Type |
|---|---|---|
| SHALL | patient | reference |
Search Parameter Combination Summary:
| Conformance | Parameter Combination | Types |
|---|---|---|
| SHOULD | patient+ status | reference+token |
| SHALL | patient+ date | reference+date |
| SHOULD | patient+ code+ date | reference+token+date |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
- The US Core Provenance resource SHALL be supported for these US Core resources:
- AllergyIntolerance
- CarePlan
- CareTeam
- Condition
- Coverage
- Device
- DiagnosticReport
- DocumentReference
- Encounter
- Goal
- Immunization
- MedicationDispense
- MedicationRequest
- Observation
- Patient
- Procedure
- QuestionnaireResponse
- RelatedPerson
- ServiceRequest
- If a system receives a provider in
Provenance.agent.whoas free text they must capture who sent them the information as the organization. On request they SHALL provide this organization as the source and MAY include the free text provider.- Systems that need to know the activity has occurred SHOULD populate the activity.
Supported Profiles:
Profile Interaction Summary:
read.vread, history-instance.create, search-type, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/Provenance/[id] Conformance Expectation: SHOULD
Resource Specific Documentation:
US Core defines two ways to represent the questions and responses to screening and assessment instruments:
- Observation: US Core Observation Screening Assessment Profile
- Questionnaire/QuestionnaireResponse: SDC Base Questionnaire/US Core QuestionnaireResponse Profile
US Core Servers SHALL support US Core Observation Screening Assessment Profile and SHOULD support the SDC Base Questionnaire Profile/US Core QuestionnaireResponse Profile
Supported Profiles:
Profile Interaction Summary:
read, vread.create, search-type, update, patch, delete, history-instance, history-type.Fetch and Search Criteria:
GET [base]/Questionnaire/[id] Conformance Expectation: SHOULD
Resource Specific Documentation:
US Core defines two ways to represent the questions and responses to screening and assessment instruments:
- Observation: US Core Observation Screening Assessment Profile
- Questionnaire/QuestionnaireResponse: SDC Base Questionnaire/US Core QuestionnaireResponse Profile
US Core Servers SHALL support US Core Observation Screening Assessment Profile and SHOULD support the SDC Base Questionnaire Profile/US Core QuestionnaireResponse Profile
Supported Profiles:
Profile Interaction Summary:
search-type, read, vread, history-instance.create, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/QuestionnaireResponse/[id] GET [base]/QuestionnaireResponse?[parameter=value]&_revinclude=Provenance:target Search Parameter Summary:
| Conformance | Parameter | Type |
|---|---|---|
| SHALL | _id | token |
| SHALL | patient | reference |
Search Parameter Combination Summary:
| Conformance | Parameter Combination | Types |
|---|---|---|
| SHOULD | patient+ status | reference+token |
| SHOULD | patient+ questionnaire | reference+reference |
| SHOULD | patient+ authored | reference+date |
Search Parameter Requirements (When Used Alone or in Combination):
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
- Systems SHOULD follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for
RelatedPerson.address.lineandRelatedPerson.address.city.
Supported Profiles:
Profile Interaction Summary:
search-type, read.vread, history-instance.create, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/RelatedPerson/[id] GET [base]/RelatedPerson?[parameter=value]&_revinclude=Provenance:target Search Parameter Summary:
| Conformance | Parameter | Type |
|---|---|---|
| SHALL | _id | token |
| SHOULD | name | string |
| SHOULD | patient | reference |
Search Parameter Combination Summary:
| Conformance | Parameter Combination | Types |
|---|---|---|
| SHOULD | patient+ name | reference+string |
Search Parameter Requirements (When Used Alone or in Combination):
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
- Servers and Clients SHALL support both US Core ServiceRequest and US Core Procedure Profiles for communicating the reason or justification for a referral as Additional USCDI Requirements. Typically, the reason or justification for a referral or consultation is communicated through
Procedure.basedOnlinking the Procedure to the US Core ServiceRequest Profile that includes eitherServiceRequest.reasonCodeorServiceRequest.reasonReference. When the Procedure does not have an associated ServiceRequest, it is communicated through the US Core Procedure Profile'sProcedure.reasonCodeorProcedure.reasonReference. Depending on the procedure being documented, a server will select the appropriate Profile to use.
ServiceRequest.reasonCodeandServiceRequest.reasonReferenceare marked as Additional USCDI Requirements. The certifying server system is not required to support both but SHALL support at least one of these elements. The certifying client application SHALL support both elements.
- when using
ServiceRequest.reasonReference:
- Servers SHALL support at least one target resource in
ServiceRequest.reasonReference. Clients SHALL support all target resources.- The referenced resources SHOULD be a US Core Profile.
Supported Profiles:
Profile Interaction Summary:
search-type, read.vread, history-instance.create, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/ServiceRequest/[id] GET [base]/ServiceRequest?[parameter=value]&_revinclude=Provenance:target Search Parameter Summary:
| Conformance | Parameter | Type |
|---|---|---|
| SHALL | _id | token |
| SHALL | patient | reference |
Search Parameter Combination Summary:
| Conformance | Parameter Combination | Types |
|---|---|---|
| SHOULD | patient+ status | reference+token |
| SHOULD | patient+ code+ authored | reference+token+date |
| SHALL | patient+ code | reference+token |
| SHALL | patient+ category+ authored | reference+token+date |
| SHALL | patient+ category | reference+token |
Search Parameter Requirements (When Used Alone or in Combination):
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
- Although both
Specimen.identifierandSpecimen.accessionIdentifierare marked as Must Support, the server system is not required to support both, but SHALL support at least one of these elements. The client application SHALL support both.
Supported Profiles:
Profile Interaction Summary:
read.vread, history-instance.create, search-type, update, patch, delete, history-type.Fetch and Search Criteria:
GET [base]/Specimen/[id] Search Parameter Summary:
| Conformance | Parameter | Type |
|---|---|---|
| SHALL | _id | token |
| SHOULD | patient | reference |
Conformance Expectation: SHOULD
Operation Summary:
If a server supports DocumentReference for creating, using, and sharing clinical notes, it SHOULD also support the context and contextdirection parameters of the $expand operation to enable clients to determine the supported note and report types, as well as the supported read/write formats for notes on the server.
{
"resourceType" : "CapabilityStatement",
"id" : "us-core-client",
"text" : {
"status" : "additional",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"> <h3 id=\"shall_igs\" class=\"no_toc\">SHALL Support the Following Implementation Guides:</h3> <ul> <li><a href=\"https://hl7.org/fhir/smart-app-launch/STU2/\">SMART App Launch 2.0.0</a></li> </ul> <h3 id=\"behavior\">FHIR RESTful Capabilities</h3> <p>The US Core Client <strong>SHALL</strong>:</p> <ol> <li>Support fetching and querying of one or more US Core profile(s), using the supported RESTful interactions and search parameters declared in the US Core Server CapabilityStatement.</li> <li>Follow the requirements documented in the <a href=\"general-requirements.html\">General Requirements</a> and <a href=\"must-support.html\">Must Support</a> pages</li> </ol> <p><strong>NOTE</strong>: US Core SearchParameters referenced in this CapabilityStatement that are derived from standard FHIR SearchParameters are only defined to document Server and Client expectations. They specify additional expectations for the following SearchParameter elements:</p> <ul> <li><code>multipleAnd</code></li> <li><code>multipleOr</code></li> <li><code>comparator</code></li> <li><code>modifier</code></li> <li><code>chain</code></li> </ul> <p>They <strong>SHALL NOT</strong> be interpreted as search parameters for search. Servers and Clients <strong>SHOULD</strong> use the standard FHIR SearchParameters.</p> <p id=\"security\"><strong>Security:</strong></p> <ol> <li>See the <a href=\"security.html\">General Security Considerations</a> section for requirements and recommendations.</li> </ol> <p><strong>Summary of System Wide Interactions</strong></p> <ul> <li><strong>MAY</strong> support the <code>transaction</code> interaction.</li> <li><strong>MAY</strong> support the <code>batch</code> interaction.</li> <li><strong>MAY</strong> support the <code>search-system</code> interaction.</li> <li><strong>MAY</strong> support the <code>history-system</code> interaction.</li> </ul> <h3 id=\"resource-details\" class=\"no_toc\">RESTful Capabilities by Resource/Profile:</h3> <h4>Summary</h4> <table class=\"grid\"> <thead> <tr> <th>Resource Type</th> <th>Supported Profiles</th> <th>Supported Searches</th> <th>Supported <code>_includes</code></th> <th>Supported <code>_revincludes</code></th> <th>Supported Operations</th> </tr> </thead> <tbody> <tr> <td> <a href=\"#allergyintolerance\">AllergyIntolerance</a> </td> <td> <a href=\"StructureDefinition-us-core-allergyintolerance.html\">US Core AllergyIntolerance Profile</a> </td> <td> clinical-status, patient patient+clinical-status </td> <td> - </td> <td> Provenance:target </td> <td> - </td> </tr> <tr> <td> <a href=\"#careplan\">CarePlan</a> </td> <td> <a href=\"StructureDefinition-us-core-careplan.html\">US Core CarePlan Profile</a> </td> <td> category, date, patient, status patient+category+status+date, patient+category+status, patient+category, patient+category+date </td> <td> - </td> <td> Provenance:target </td> <td> - </td> </tr> <tr> <td> <a href=\"#careteam\">CareTeam</a> </td> <td> <a href=\"StructureDefinition-us-core-careteam.html\">US Core CareTeam Profile</a> </td> <td> patient, role, status patient+status, patient+role </td> <td> CareTeam:participant:PractitionerRole, CareTeam:participant:Practitioner, CareTeam:participant:Patient, CareTeam:participant:RelatedPerson </td> <td> Provenance:target </td> <td> - </td> </tr> <tr> <td> <a href=\"#condition\">Condition</a> </td> <td> <a href=\"StructureDefinition-us-core-condition-encounter-diagnosis.html\">US Core Condition Encounter Diagnosis Profile</a>, <a href=\"StructureDefinition-us-core-condition-problems-health-concerns.html\">US Core Condition Problems and Health Concerns Profile</a> </td> <td> abatement-date, asserted-date, category, clinical-status, code, encounter, onset-date, patient, recorded-date, _lastUpdated patient+onset-date, patient+_lastUpdated, patient+category+encounter, patient+category+clinical-status, patient+recorded-date, patient+asserted-date, patient+abatement-date, patient+code, patient+category, patient+clinical-status </td> <td> - </td> <td> Provenance:target </td> <td> - </td> </tr> <tr> <td> <a href=\"#coverage\">Coverage</a> </td> <td> <a href=\"StructureDefinition-us-core-coverage.html\">US Core Coverage Profile</a> </td> <td> patient </td> <td> - </td> <td> Provenance:target </td> <td> - </td> </tr> <tr> <td> <a href=\"#device\">Device</a> </td> <td> <a href=\"StructureDefinition-us-core-implantable-device.html\">US Core Implantable Device Profile</a> </td> <td> patient, status, type patient+type, patient+status </td> <td> - </td> <td> Provenance:target </td> <td> - </td> </tr> <tr> <td> <a href=\"#diagnosticreport\">DiagnosticReport</a> </td> <td> <a href=\"StructureDefinition-us-core-diagnosticreport-note.html\">US Core DiagnosticReport Profile for Report and Note exchange</a>, <a href=\"StructureDefinition-us-core-diagnosticreport-lab.html\">US Core DiagnosticReport Profile for Laboratory Results Reporting</a> </td> <td> category, code, date, _lastUpdated, patient, status patient+status, patient+code+date, patient+category+date, patient+code, patient+category+_lastUpdated, patient+category </td> <td> - </td> <td> Provenance:target </td> <td> - </td> </tr> <tr> <td> <a href=\"#documentreference\">DocumentReference</a> </td> <td> <a href=\"StructureDefinition-us-core-documentreference.html\">US Core DocumentReference Profile</a> </td> <td> _id, category, date, patient, period, status, type patient+status, patient+category+date, patient+type+period, patient+type, patient+category </td> <td> - </td> <td> Provenance:target </td> <td> docref </td> </tr> <tr> <td> <a href=\"#encounter\">Encounter</a> </td> <td> <a href=\"StructureDefinition-us-core-encounter.html\">US Core Encounter Profile</a> </td> <td> _id, class, date, _lastUpdated, discharge-disposition, identifier, location, patient, status, type patient+status, patient+_lastUpdated, date+patient, patient+type, patient+location, patient+discharge-disposition, class+patient </td> <td> - </td> <td> Provenance:target </td> <td> - </td> </tr> <tr> <td> <a href=\"#endpoint\">Endpoint</a> </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href=\"#goal\">Goal</a> </td> <td> <a href=\"StructureDefinition-us-core-goal.html\">US Core Goal Profile</a> </td> <td> description, lifecycle-status, patient, target-date patient+target-date, patient+lifecycle-status, patient+description </td> <td> - </td> <td> Provenance:target </td> <td> - </td> </tr> <tr> <td> <a href=\"#healthcareservice\">HealthcareService</a> </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href=\"#immunization\">Immunization</a> </td> <td> <a href=\"StructureDefinition-us-core-immunization.html\">US Core Immunization Profile</a> </td> <td> date, patient, status patient+status, patient+date </td> <td> - </td> <td> Provenance:target </td> <td> - </td> </tr> <tr> <td> <a href=\"#location\">Location</a> </td> <td> <a href=\"StructureDefinition-us-core-location.html\">US Core Location Profile</a> </td> <td> address, address-city, address-postalcode, address-state, name </td> <td> - </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href=\"#media\">Media</a> </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href=\"#medication\">Medication</a> </td> <td> <a href=\"StructureDefinition-us-core-medication.html\">US Core Medication Profile</a> </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href=\"#medicationdispense\">MedicationDispense</a> </td> <td> <a href=\"StructureDefinition-us-core-medicationdispense.html\">US Core MedicationDispense Profile</a> </td> <td> patient, status, type patient+status, patient+status+type </td> <td> MedicationDispense:medication </td> <td> Provenance:target </td> <td> - </td> </tr> <tr> <td> <a href=\"#medicationrequest\">MedicationRequest</a> </td> <td> <a href=\"StructureDefinition-us-core-medicationrequest.html\">US Core MedicationRequest Profile</a> </td> <td> authoredon, encounter, intent, patient, status patient+intent+authoredon, patient+intent+status, patient+intent, patient+intent+encounter </td> <td> MedicationRequest:medication </td> <td> Provenance:target </td> <td> - </td> </tr> <tr> <td> <a href=\"#observation\">Observation</a> </td> <td> <a href=\"StructureDefinition-us-core-observation-lab.html\">US Core Laboratory Result Observation Profile</a>, <a href=\"StructureDefinition-us-core-observation-pregnancystatus.html\">US Core Observation Pregnancy Status Profile</a>, <a href=\"StructureDefinition-us-core-observation-pregnancyintent.html\">US Core Observation Pregnancy Intent Profile</a>, <a href=\"StructureDefinition-us-core-observation-occupation.html\">US Core Observation Occupation Profile</a>, <a href=\"StructureDefinition-us-core-respiratory-rate.html\">US Core Respiratory Rate Profile</a>, <a href=\"StructureDefinition-us-core-simple-observation.html\">US Core Simple Observation Profile</a>, <a href=\"StructureDefinition-us-core-treatment-intervention-preference.html\">US Core Treatment Intervention Preference Profile</a>, <a href=\"StructureDefinition-us-core-care-experience-preference.html\">US Core Care Experience Preference Profile</a>, <a href=\"StructureDefinition-us-core-heart-rate.html\">US Core Heart Rate Profile</a>, <a href=\"StructureDefinition-us-core-body-temperature.html\">US Core Body Temperature Profile</a>, <a href=\"StructureDefinition-pediatric-weight-for-height.html\">US Core Pediatric Weight for Height Observation Profile</a>, <a href=\"StructureDefinition-us-core-pulse-oximetry.html\">US Core Pulse Oximetry Profile</a>, <a href=\"StructureDefinition-us-core-smokingstatus.html\">US Core Smoking Status Observation Profile</a>, <a href=\"StructureDefinition-us-core-observation-sexual-orientation.html\">US Core Observation Sexual Orientation Profile</a>, <a href=\"StructureDefinition-us-core-head-circumference.html\">US Core Head Circumference Profile</a>, <a href=\"StructureDefinition-us-core-body-height.html\">US Core Body Height Profile</a>, <a href=\"StructureDefinition-us-core-bmi.html\">US Core BMI Profile</a>, <a href=\"StructureDefinition-us-core-observation-screening-assessment.html\">US Core Observation Screening Assessment Profile</a>, <a href=\"StructureDefinition-us-core-average-blood-pressure.html\">US Core Average Blood Pressure Profile</a>, <a href=\"StructureDefinition-us-core-blood-pressure.html\">US Core Blood Pressure Profile</a>, <a href=\"StructureDefinition-us-core-observation-clinical-result.html\">US Core Observation Clinical Result Profile</a>, <a href=\"StructureDefinition-pediatric-bmi-for-age.html\">US Core Pediatric BMI for Age Observation Profile</a>, <a href=\"StructureDefinition-head-occipital-frontal-circumference-percentile.html\">US Core Pediatric Head Occipital Frontal Circumference Percentile Profile</a>, <a href=\"StructureDefinition-us-core-body-weight.html\">US Core Body Weight Profile</a>, <a href=\"StructureDefinition-us-core-vital-signs.html\">US Core Vital Signs Profile</a> </td> <td> category, code, date, _lastUpdated, patient, status patient+code+date, patient+category+date, patient+code, patient+category+_lastUpdated, patient+category, patient+category+status </td> <td> - </td> <td> Provenance:target </td> <td> - </td> </tr> <tr> <td> <a href=\"#organization\">Organization</a> </td> <td> <a href=\"StructureDefinition-us-core-organization.html\">US Core Organization Profile</a> </td> <td> address, name </td> <td> - </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href=\"#patient\">Patient</a> </td> <td> <a href=\"StructureDefinition-us-core-patient.html\">US Core Patient Profile</a> </td> <td> _id, birthdate, death-date, family, gender, given, identifier, name family+gender, birthdate+name, death-date+family, gender+name, birthdate+family </td> <td> - </td> <td> Provenance:target </td> <td> - </td> </tr> <tr> <td> <a href=\"#practitioner\">Practitioner</a> </td> <td> <a href=\"StructureDefinition-us-core-practitioner.html\">US Core Practitioner Profile</a> </td> <td> _id, identifier, name </td> <td> - </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href=\"#practitionerrole\">PractitionerRole</a> </td> <td> <a href=\"StructureDefinition-us-core-practitionerrole.html\">US Core PractitionerRole Profile</a> </td> <td> practitioner, specialty </td> <td> PractitionerRole:endpoint, PractitionerRole:practitioner </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href=\"#procedure\">Procedure</a> </td> <td> <a href=\"StructureDefinition-us-core-procedure.html\">US Core Procedure Profile</a> </td> <td> code, date, patient, status patient+status, patient+date, patient+code+date </td> <td> - </td> <td> Provenance:target </td> <td> - </td> </tr> <tr> <td> <a href=\"#provenance\">Provenance</a> </td> <td> <a href=\"StructureDefinition-us-core-provenance.html\">US Core Provenance Profile</a> </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href=\"#questionnaire\">Questionnaire</a> </td> <td> <a href=\"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire\">SDC Base Questionnaire Profile</a> </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href=\"#questionnaireresponse\">QuestionnaireResponse</a> </td> <td> <a href=\"StructureDefinition-us-core-questionnaireresponse.html\">US Core QuestionnaireResponse Profile</a> </td> <td> _id, authored, patient, questionnaire, status patient+status, patient+questionnaire, patient+authored </td> <td> - </td> <td> Provenance:target </td> <td> - </td> </tr> <tr> <td> <a href=\"#relatedperson\">RelatedPerson</a> </td> <td> <a href=\"StructureDefinition-us-core-relatedperson.html\">US Core RelatedPerson Profile</a> </td> <td> _id, name, patient patient+name </td> <td> - </td> <td> Provenance:target </td> <td> - </td> </tr> <tr> <td> <a href=\"#servicerequest\">ServiceRequest</a> </td> <td> <a href=\"StructureDefinition-us-core-servicerequest.html\">US Core ServiceRequest Profile</a> </td> <td> _id, authored, category, code, patient, status patient+status, patient+code+authored, patient+code, patient+category+authored, patient+category </td> <td> - </td> <td> Provenance:target </td> <td> - </td> </tr> <tr> <td> <a href=\"#specimen\">Specimen</a> </td> <td> <a href=\"StructureDefinition-us-core-specimen.html\">US Core Specimen Profile</a> </td> <td> _id, patient </td> <td> - </td> <td> - </td> <td> - </td> </tr> <tr> <td> <a href=\"#valueset\">ValueSet</a> </td> <td> - </td> <td> - </td> <td> - </td> <td> - </td> <td> expand </td> </tr> </tbody> </table> <h4 id=\"allergyintolerance\" class=\"no_toc\">AllergyIntolerance</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-allergyintolerance.html\">US Core AllergyIntolerance Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a AllergyIntolerance resource using: <code class=\"highlighter-rouge\">GET [base]/AllergyIntolerance/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes: Provenance:target - <code class=\"highlighter-rouge\">GET [base]/AllergyIntolerance?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-allergyintolerance-patient.html\"> patient</a> </td> <td> reference </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-allergyintolerance-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-allergyintolerance-clinical-status.html\"> clinical-status</a> </td> <td>reference+token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-allergyintolerance-clinical-status.html\"> clinical-status</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-allergyintolerance-patient.html\"> patient</a> (reference):<p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li> </ul> </div> <hr/> <h4 id=\"careplan\" class=\"no_toc\">CarePlan</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>Additional considerations for systems aligning with <a href=\"http://www.hl7.org/implement/standards/product_brief.cfm?product_id=492\">HL7 Consolidated (C-CDA)</a> Care Plan requirements: <ul> <li>US Core Goal <strong>SHOULD</strong> be present in CarePlan.goal</li> <li>US Core Condition <strong>SHOULD</strong> be present in CarePlan.addresses</li> <li>Assessment and Plan <strong>MAY</strong> be included as narrative text</li> </ul> </li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-careplan.html\">US Core CarePlan Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a CarePlan resource using: <code class=\"highlighter-rouge\">GET [base]/CarePlan/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes: Provenance:target - <code class=\"highlighter-rouge\">GET [base]/CarePlan?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Combination Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-careplan-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-careplan-category.html\"> category</a>+ <a href=\"SearchParameter-us-core-careplan-status.html\"> status</a>+ <a href=\"SearchParameter-us-core-careplan-date.html\"> date</a> </td> <td>reference+token+token+date </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-careplan-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-careplan-category.html\"> category</a>+ <a href=\"SearchParameter-us-core-careplan-status.html\"> status</a> </td> <td>reference+token+token </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-careplan-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-careplan-category.html\"> category</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-careplan-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-careplan-category.html\"> category</a>+ <a href=\"SearchParameter-us-core-careplan-date.html\"> date</a> </td> <td>reference+token+date </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-careplan-category.html\"> category</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-careplan-date.html\"> date</a> (date):<p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> </li><li><a href=\"SearchParameter-us-core-careplan-patient.html\"> patient</a> (reference):<p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-careplan-status.html\"> status</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li> </ul> </div> <hr/> <h4 id=\"careteam\" class=\"no_toc\">CareTeam</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>In order to access care team member's names, identifiers, locations, and contact information, the CareTeam profile supports several types of care team participants. They are represented as references to other profiles and include the following four profiles which are marked as must support: <ol> <li>US Core Practitioner Profile</li> <li>US Core PractitionerRole Profile</li> <li>US Core Patient Profile</li> <li>US Core RelatedPerson Profile</li> </ol> </li> <li>Although <em>both</em> US Core Practitioner Profile and US Core PractitionerRole are must support, the server system is not required to support both types of references, but <strong>SHALL</strong> support <em>at least</em> one of them.</li> <li>The client application <strong>SHALL</strong> support all four profile references.</li> <li>Bacause the <em>US Core PractitionerRole Profile</em> supplies the provider's location and contact information and a reference to the Practitioner, server systems <strong>SHOULD</strong> reference it instead of the <em>US Core Practitioner Profile</em>.</li> <li>Servers that support only US Core Practitioner Profile and do not support the US Core PractitionerRole Profile <strong>SHALL</strong> provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource.</li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-careteam.html\">US Core CareTeam Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a CareTeam resource using: <code class=\"highlighter-rouge\">GET [base]/CareTeam/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _includes: <ul> <li> CareTeam:participant:PractitionerRole: <code class=\"highlighter-rouge\">GET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:PractitionerRole</code> </li> <li> CareTeam:participant:Practitioner: <code class=\"highlighter-rouge\">GET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:Practitioner</code> </li> <li> CareTeam:participant:Patient: <code class=\"highlighter-rouge\">GET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:Patient</code> </li> <li> CareTeam:participant:RelatedPerson: <code class=\"highlighter-rouge\">GET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:RelatedPerson</code> </li> </ul> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes: Provenance:target - <code class=\"highlighter-rouge\">GET [base]/CareTeam?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> </tr> </thead> <tbody><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-careteam-role.html\"> role</a> </td> <td> token </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-careteam-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-careteam-status.html\"> status</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-careteam-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-careteam-role.html\"> role</a> </td> <td>reference+token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-careteam-patient.html\"> patient</a> (reference):<p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-careteam-role.html\"> role</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-careteam-status.html\"> status</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li> </ul> </div> <hr/> <h4 id=\"condition\" class=\"no_toc\">Condition</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>Clients <strong>SHALL</strong> support at least one Condition Profile</li> <li>For Encounter Diagnosis use the <em>US Core Condition Encounter Diagnosis Profile</em>. <ul> <li>When <code>Condition.category</code> is "encounter-diagnosis" the encounter, <strong>SHOULD</strong> be referenced in <code>Condition.encounter</code>.</li> </ul> </li> <li>For Problems and Health Concerns use the <em>US Core Condition Problems and Health Concerns Profile</em>. <ul> <li>When <code>Condition.category</code> is a "problems-list-item", the `Condition.clinicalStatus <strong>SHOULD NOT</strong> be unknown.</li> </ul> </li> <li>There is no single element in Condition that represents the date of diagnosis. It may be the assertedDate Extension, <code>Condition.onsetDateTime</code>, or <code>Condition.recordedDate</code>. <ul> <li>Although all three are marked as must support, the server is not required to support all.</li> <li>A server <strong>SHALL</strong> support <code>Condition.recordedDate</code>.</li> <li>A server <strong>SHALL</strong> support at least one of the assertedDate Extension and <code>Condition.onsetDateTime</code>. A server may support both, which means they support all three elements.</li> <li>The client application <strong>SHALL</strong> support all three elements.</li> </ul> </li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-condition-encounter-diagnosis.html\">US Core Condition Encounter Diagnosis Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-condition-problems-health-concerns.html\">US Core Condition Problems and Health Concerns Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a Condition resource using: <code class=\"highlighter-rouge\">GET [base]/Condition/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes: Provenance:target - <code class=\"highlighter-rouge\">GET [base]/Condition?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-condition-patient.html\"> patient</a> </td> <td> reference </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-condition-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-condition-onset-date.html\"> onset-date</a> </td> <td>reference+date </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-condition-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-condition-lastupdated.html\"> _lastUpdated</a> </td> <td>reference+date </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-condition-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-condition-category.html\"> category</a>+ <a href=\"SearchParameter-us-core-condition-encounter.html\"> encounter</a> </td> <td>reference+token+reference </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-condition-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-condition-category.html\"> category</a>+ <a href=\"SearchParameter-us-core-condition-clinical-status.html\"> clinical-status</a> </td> <td>reference+token+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-condition-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-condition-recorded-date.html\"> recorded-date</a> </td> <td>reference+date </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-condition-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-condition-asserted-date.html\"> asserted-date</a> </td> <td>reference+date </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-condition-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-condition-abatement-date.html\"> abatement-date</a> </td> <td>reference+date </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-condition-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-condition-code.html\"> code</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-condition-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-condition-category.html\"> category</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-condition-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-condition-clinical-status.html\"> clinical-status</a> </td> <td>reference+token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-condition-abatement-date.html\"> abatement-date</a> (date):<p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> </li><li><a href=\"SearchParameter-us-core-condition-asserted-date.html\"> asserted-date</a> (date):<p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> </li><li><a href=\"SearchParameter-us-core-condition-category.html\"> category</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-condition-clinical-status.html\"> clinical-status</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-condition-code.html\"> code</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-condition-encounter.html\"> encounter</a> (reference):<p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-condition-onset-date.html\"> onset-date</a> (date):<p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> </li><li><a href=\"SearchParameter-us-core-condition-patient.html\"> patient</a> (reference):<p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-condition-recorded-date.html\"> recorded-date</a> (date):<p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> </li><li><a href=\"SearchParameter-us-core-condition-lastupdated.html\"> _lastUpdated</a> (date):<p>A server <strong>SHALL</strong> document the types of changes that can be detected using this parameter.</p> <p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> </li> </ul> </div> <hr/> <h4 id=\"coverage\" class=\"no_toc\">Coverage</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-coverage.html\">US Core Coverage Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a Coverage resource using: <code class=\"highlighter-rouge\">GET [base]/Coverage/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes: Provenance:target - <code class=\"highlighter-rouge\">GET [base]/Coverage?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-coverage-patient.html\"> patient</a> </td> <td> reference </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-coverage-patient.html\"> patient</a> (reference):<p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li> </ul> </div> <hr/> <h4 id=\"device\" class=\"no_toc\">Device</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li> <p>Implantable medical devices that have UDI information <strong>SHALL</strong> represent the UDI code in <code>Device.udiCarrier.carrierHRF</code>.</p> <ul> <li>All of the five UDI-PI elements that are present in the UDI code <strong>SHALL</strong> be represented in the corresponding US Core Implantable Device Profile element.</li> </ul> <p>UDI may not be present in all scenarios such as historical implantable devices, patient reported implant information, payer reported devices, or improperly documented implants. If UDI is not present and the manufacturer and/or model number information is available, they <strong>SHOULD</strong> be included to support historical reports of implantable medical devices as follows:</p> <p>manufacturer -> <code>Device.manufacturer</code><br/> model -> <code>Device.model</code></p> </li> <li> <p>Servers <strong>SHOULD</strong> support query by Device.type to allow clients to request the patient's devices by a specific type. Note: The Device.type is too granular to differentiate implantable vs. non-implantable devices.</p> </li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-implantable-device.html\">US Core Implantable Device Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a Device resource using: <code class=\"highlighter-rouge\">GET [base]/Device/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes: Provenance:target - <code class=\"highlighter-rouge\">GET [base]/Device?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-device-patient.html\"> patient</a> </td> <td> reference </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-device-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-device-type.html\"> type</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-device-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-device-status.html\"> status</a> </td> <td>reference+token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-device-patient.html\"> patient</a> (reference):<p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-device-status.html\"> status</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-device-type.html\"> type</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li> </ul> </div> <hr/> <h4 id=\"diagnosticreport\" class=\"no_toc\">DiagnosticReport</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>Clients <strong>SHALL</strong> support at least one DiagnosticReport Profile</li> <li>When <code>DiagnosticReport.category</code> is "LAB" the encounter, Updates to Meta.lastUpdated <strong>SHOULD</strong> reflect: <ul> <li>New laboratory reports</li> <li>Changes in the status of laboratory reports including events that trigger the same status (e.g., amended → amended).</li> </ul> </li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-diagnosticreport-note.html\">US Core DiagnosticReport Profile for Report and Note exchange</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-diagnosticreport-lab.html\">US Core DiagnosticReport Profile for Laboratory Results Reporting</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>create</code><sup>†</sup>, <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <blockquote>create<sup>†</sup><p>This conformance expectation applies <strong>only</strong> to the <em>US Core DiagnosticReport Profile for Report and Note exchange</em> profile. The conformance expectation for the <em>US Core DiagnosticReport Profile for Laboratory Results Reporting</em> is <strong>MAY</strong>.</p> </blockquote> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a DiagnosticReport resource using: <code class=\"highlighter-rouge\">GET [base]/DiagnosticReport/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes: Provenance:target - <code class=\"highlighter-rouge\">GET [base]/DiagnosticReport?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-diagnosticreport-patient.html\"> patient</a> </td> <td> reference </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-diagnosticreport-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-diagnosticreport-status.html\"> status</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-diagnosticreport-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-diagnosticreport-code.html\"> code</a>+ <a href=\"SearchParameter-us-core-diagnosticreport-date.html\"> date</a> </td> <td>reference+token+date </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-diagnosticreport-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-diagnosticreport-category.html\"> category</a>+ <a href=\"SearchParameter-us-core-diagnosticreport-date.html\"> date</a> </td> <td>reference+token+date </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-diagnosticreport-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-diagnosticreport-code.html\"> code</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-diagnosticreport-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-diagnosticreport-category.html\"> category</a>+ <a href=\"SearchParameter-us-core-diagnosticreport-lastupdated.html\"> _lastUpdated</a> </td> <td>reference+token+date </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-diagnosticreport-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-diagnosticreport-category.html\"> category</a> </td> <td>reference+token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-diagnosticreport-category.html\"> category</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-diagnosticreport-code.html\"> code</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-diagnosticreport-date.html\"> date</a> (date):<p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> </li><li><a href=\"SearchParameter-us-core-diagnosticreport-lastupdated.html\"> _lastUpdated</a> (date):<p>A server <strong>SHALL</strong> document the types of changes that can be detected using this parameter.</p> <p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> </li><li><a href=\"SearchParameter-us-core-diagnosticreport-patient.html\"> patient</a> (reference):<p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-diagnosticreport-status.html\"> status</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li> </ul> </div> <hr/> <h4 id=\"documentreference\" class=\"no_toc\">DocumentReference</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>The <code>DocumentReference.type</code> binding <strong>SHALL</strong> support at a minimum the <a href=\"ValueSet-us-core-clinical-note-type.html\">5 Common Clinical Notes</a> and may extend to the full US Core DocumentReference Type Value Set</li> <li>The DocumentReference resources can represent the referenced content using either an address where the document can be retrieved using <code>DocumentReference.attachment.url</code> or the content as inline base64 encoded data using <code>DocumentReference.attachment.data</code>. <ul> <li>Although both are marked as must support, the server system is not required to support an address, and inline base64 encoded data, but <strong>SHALL</strong> support at least one of these elements.</li> <li>The client application <strong>SHALL</strong> support both elements.</li> <li>The <code>content.url</code> may refer to a FHIR Binary Resource (i.e. [base]/Binary/[id]), FHIR Document Bundle (i.e [base]/Bundle/[id] or another endpoint. <ul> <li>If the endpoint is outside the FHIR base URL, it <strong>SHOULD NOT</strong> require additional authorization to access.</li> </ul> </li> <li>If there are multiple <code>DocumentReference.content</code> element repetitions, these <strong>SHALL</strong> all represent the same document in different format or attachment metadata. The content element <strong>SHALL NOT</strong> contain different versions of the same content. For version handling use multiple DocumentReferences with <code>DocumentReference.relatesTo</code></li> </ul> </li> <li>Every DocumentReference must have a responsible Organization. The organization responsible for the DocumentReference <strong>SHALL</strong> be present either in <code>DocumentReference.custodian</code> or accessible in the Provenance resource targeting the DocumentReference using <code>Provenance.agent.who</code> or <code>Provenance.agent.onBehalfOf</code>.</li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-documentreference.html\">US Core DocumentReference Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>create</code>, <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Operation Summary:</p> <ul> <li><strong>SHOULD</strong> support the <a href=\"OperationDefinition-docref.html\">$docref</a> operation <p>A client <strong>SHOULD</strong> be capable of transacting a $docref operation and capable of receiving at least a reference to a generated CCD document, and <strong>MAY</strong> be able to receive other document types, if available. <strong>SHOULD</strong> be capable of receiving documents as included resources in response to the operation.</p> <p><code>GET [base]/DocumentReference/$docref?patient=[id]</code></p> </li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a DocumentReference resource using: <code class=\"highlighter-rouge\">GET [base]/DocumentReference/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes: Provenance:target - <code class=\"highlighter-rouge\">GET [base]/DocumentReference?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-documentreference-id.html\"> _id</a> </td> <td> token </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-documentreference-patient.html\"> patient</a> </td> <td> reference </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-documentreference-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-documentreference-status.html\"> status</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-documentreference-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-documentreference-category.html\"> category</a>+ <a href=\"SearchParameter-us-core-documentreference-date.html\"> date</a> </td> <td>reference+token+date </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-documentreference-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-documentreference-type.html\"> type</a>+ <a href=\"SearchParameter-us-core-documentreference-period.html\"> period</a> </td> <td>reference+token+date </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-documentreference-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-documentreference-type.html\"> type</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-documentreference-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-documentreference-category.html\"> category</a> </td> <td>reference+token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-documentreference-category.html\"> category</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-documentreference-date.html\"> date</a> (date):<p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> </li><li><a href=\"SearchParameter-us-core-documentreference-patient.html\"> patient</a> (reference):<p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-documentreference-period.html\"> period</a> (date):<p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> </li><li><a href=\"SearchParameter-us-core-documentreference-status.html\"> status</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-documentreference-type.html\"> type</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li> </ul> </div> <hr/> <h4 id=\"encounter\" class=\"no_toc\">Encounter</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li> <p>The Encounter resource can represent a reason using either a code with <code>Encounter.reasonCode</code>, or a reference with <code>Encounter.reasonReference</code> to Condition or other resource.</p> <ul> <li>Although both are marked as must support, the server systems are not required to support both a code and a reference, but they <strong>SHALL</strong> support <em>at least one</em> of these elements.</li> <li>The client application <strong>SHALL</strong> support both elements.</li> <li>if <code>Encounter.reasonReference</code> references an Observation, it <strong>SHOULD</strong> conform to a US Core Observation if applicable. (for example, a laboratory result should conform to the US Core Laboratory Result Observation Profile)</li> </ul> </li> <li> <p>The location address can be represented by either by the Location referenced by <code>Encounter.location.location</code> or indirectly through the Organization referenced by <code>Encounter.serviceProvider</code>.</p> <ul> <li>Although both are marked as must support, the server systems are not required to support both <code>Encounter.location.location</code> and <code>Encounter.serviceProvider</code>, but they <strong>SHALL</strong> support <em>at least one</em> of these elements.</li> <li>The client application <strong>SHALL</strong> support both elements.</li> </ul> </li> <li> <p>If the event facility/location differs from the <code>Encounter.location</code>, systems <strong>SHOULD</strong> reference it directly:</p> </li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-encounter.html\">US Core Encounter Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a Encounter resource using: <code class=\"highlighter-rouge\">GET [base]/Encounter/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes: Provenance:target - <code class=\"highlighter-rouge\">GET [base]/Encounter?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-encounter-id.html\"> _id</a> </td> <td> token </td> </tr><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-encounter-identifier.html\"> identifier</a> </td> <td> token </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-encounter-patient.html\"> patient</a> </td> <td> reference </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-encounter-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-encounter-status.html\"> status</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-encounter-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-encounter-lastupdated.html\"> _lastUpdated</a> </td> <td>reference+date </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-encounter-date.html\"> date</a>+ <a href=\"SearchParameter-us-core-encounter-patient.html\"> patient</a> </td> <td>date+reference </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-encounter-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-encounter-type.html\"> type</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-encounter-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-encounter-location.html\"> location</a> </td> <td>reference+reference </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-encounter-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-encounter-discharge-disposition.html\"> discharge-disposition</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-encounter-class.html\"> class</a>+ <a href=\"SearchParameter-us-core-encounter-patient.html\"> patient</a> </td> <td>token+reference </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-encounter-class.html\"> class</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-encounter-date.html\"> date</a> (date):<p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> </li><li><a href=\"SearchParameter-us-core-encounter-lastupdated.html\"> _lastUpdated</a> (date):<p>A server <strong>SHALL</strong> document the types of changes that can be detected using this parameter.</p> <p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> </li><li><a href=\"SearchParameter-us-core-encounter-discharge-disposition.html\"> discharge-disposition</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-encounter-identifier.html\"> identifier</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-encounter-location.html\"> location</a> (reference):<p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-encounter-patient.html\"> patient</a> (reference):<p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-encounter-status.html\"> status</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-encounter-type.html\"> type</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li> </ul> </div> <hr/> <h4 id=\"endpoint\" class=\"no_toc\">Endpoint</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>The Media Resource is a Must Support referenced resource when using the US Core PractitionerRole Profile.</p> </blockquote> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>read</code>, <code>vread</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>search-type</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHOULD</strong> be capable of fetching a Endpoint resource using: <code class=\"highlighter-rouge\">GET [base]/Endpoint/[id]</code> </li> </ul> <hr/> <h4 id=\"goal\" class=\"no_toc\">Goal</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>Although both <code>Goal.startDate</code> and <code>Goal.target.dueDate</code> are marked as must support, the server system is not required to support both, but <strong>SHALL</strong> support at least one of these elements. The client application <strong>SHALL</strong> support both elements.</li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-goal.html\">US Core Goal Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a Goal resource using: <code class=\"highlighter-rouge\">GET [base]/Goal/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes: Provenance:target - <code class=\"highlighter-rouge\">GET [base]/Goal?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-goal-patient.html\"> patient</a> </td> <td> reference </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-goal-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-goal-target-date.html\"> target-date</a> </td> <td>reference+date </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-goal-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-goal-lifecycle-status.html\"> lifecycle-status</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-goal-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-goal-description.html\"> description</a> </td> <td>reference+token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-goal-lifecycle-status.html\"> lifecycle-status</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-goal-patient.html\"> patient</a> (reference):<p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-goal-target-date.html\"> target-date</a> (date):<p>A client <strong>SHALL</strong> provide a value precise to the <em>day</em>.</p> <p>A server <strong>SHALL</strong> support a value a value precise to the <em>day</em>.</p> </li> </ul> </div> <hr/> <h4 id=\"healthcareservice\" class=\"no_toc\">HealthcareService</h4> <p>Conformance Expectation: <strong>MAY</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>The HealthcareService Resource is a referenced resource when using the US Core PracitionRole Profile and subject to constraint us-core-13: "SHALL have a practitioner, an organization, a healthcare service, or a location."</p> </blockquote> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>read</code>, <code>vread</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>search-type</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHOULD</strong> be capable of fetching a HealthcareService resource using: <code class=\"highlighter-rouge\">GET [base]/HealthcareService/[id]</code> </li> </ul> <hr/> <h4 id=\"immunization\" class=\"no_toc\">Immunization</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>Based upon the ONC U.S. Core Data for Interoperability (USCDI) requirements, CVX vaccine codes are required and the NDC vaccine codes <strong>SHOULD</strong> be supported as translations to them.</li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-immunization.html\">US Core Immunization Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a Immunization resource using: <code class=\"highlighter-rouge\">GET [base]/Immunization/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes: Provenance:target - <code class=\"highlighter-rouge\">GET [base]/Immunization?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-immunization-patient.html\"> patient</a> </td> <td> reference </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-immunization-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-immunization-status.html\"> status</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-immunization-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-immunization-date.html\"> date</a> </td> <td>reference+date </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-immunization-date.html\"> date</a> (date):<p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> </li><li><a href=\"SearchParameter-us-core-immunization-patient.html\"> patient</a> (reference):<p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-immunization-status.html\"> status</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li> </ul> </div> <hr/> <h4 id=\"location\" class=\"no_toc\">Location</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>Systems <strong>SHOULD</strong> follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for <code>Location.address.line</code> and <code>Location.address.city</code>.</li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-location.html\">US Core Location Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a Location resource using: <code class=\"highlighter-rouge\">GET [base]/Location/[id]</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-location-address.html\"> address</a> </td> <td> string </td> </tr><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-location-address-city.html\"> address-city</a> </td> <td> string </td> </tr><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-location-address-postalcode.html\"> address-postalcode</a> </td> <td> string </td> </tr><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-location-address-state.html\"> address-state</a> </td> <td> string </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-location-name.html\"> name</a> </td> <td> string </td> </tr> </tbody> </table> <hr/> <h4 id=\"media\" class=\"no_toc\">Media</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>The Media Resource is a Must Support referenced resource when using the US Core DiagnosticReport Profile for Report and Note Exchange.</p> </blockquote> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>read</code>, <code>vread</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>search-type</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHOULD</strong> be capable of fetching a Media resource using: <code class=\"highlighter-rouge\">GET [base]/Media/[id]</code> </li> </ul> <hr/> <h4 id=\"medication\" class=\"no_toc\">Medication</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>The MedicationRequest resource can represent a medication, using an external reference to a Medication resource. If an external Medication Resource is used in a MedicationRequest, then the READ <strong>SHALL</strong> be supported.</li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-medication.html\">US Core Medication Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>search-type</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a Medication resource using: <code class=\"highlighter-rouge\">GET [base]/Medication/[id]</code> </li> </ul> <hr/> <h4 id=\"medicationdispense\" class=\"no_toc\">MedicationDispense</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>The MedicationDispense resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be <a href=\"http://hl7.org/fhir/R4/references.html#contained\">contained</a> or an external resource. The server application <strong>MAY</strong> choose any one way or more than one method, but if an external reference to Medication is used, the server <strong>SHALL</strong> support the _include` parameter for searching this element. The client application must support all methods. <ul> <li>For example, A server <strong>SHALL</strong> be capable of returning dispense records for all medications for a patient using one of or both: <ul> <li><code>GET /MedicationDispense?patient=[id]</code></li> <li><code>GET /MedicationDispense?patient=[id]&_include=MedicationDispense:medication</code></li> </ul> </li> </ul> </li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-medicationdispense.html\">US Core MedicationDispense Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a MedicationDispense resource using: <code class=\"highlighter-rouge\">GET [base]/MedicationDispense/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _includes: <ul> <li> MedicationDispense:medication: <code class=\"highlighter-rouge\">GET [base]/MedicationDispense?[parameter=value]&_include=MedicationDispense:medication</code> </li> </ul> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes: Provenance:target - <code class=\"highlighter-rouge\">GET [base]/MedicationDispense?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-medicationdispense-patient.html\"> patient</a> </td> <td> reference </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-medicationdispense-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-medicationdispense-status.html\"> status</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-medicationdispense-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-medicationdispense-status.html\"> status</a>+ <a href=\"SearchParameter-us-core-medicationdispense-type.html\"> type</a> </td> <td>reference+token+token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-medicationdispense-patient.html\"> patient</a> (reference):<p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-medicationdispense-status.html\"> status</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-medicationdispense-type.html\"> type</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li> </ul> </div> <hr/> <h4 id=\"medicationrequest\" class=\"no_toc\">MedicationRequest</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li> <p>The MedicationRequest resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be <a href=\"http://hl7.org/fhir/R4/references.html#contained\">contained</a> or an external resource. The server application <strong>MAY</strong> choose any one way or more than one method, but if an external reference to Medication is used, the server <strong>SHALL</strong> support the _include` parameter for searching this element. The client application must support all methods.</p> <ul> <li>For example, A server <strong>SHALL</strong> be capable of returning all medications for a patient using one of or both: <ul> <li><code>GET /MedicationRequest?patient=[id]</code></li> <li><code>GET /MedicationRequest?patient=[id]&_include=MedicationRequest:medication</code></li> </ul> </li> </ul> </li> <li> <p>The MedicationRequest resource can represent that information is from a secondary source using either a boolean flag or reference in <code>MedicationRequest.reportedBoolean</code>, or a reference using <code>MedicationRequest.reportedReference</code> to Practitioner or other resource.</p> <ul> <li>Although both are marked as must support, the server systems are not required to support both a boolean and a reference, but <strong>SHALL</strong> choose to support at least one of these elements.</li> <li>The client application <strong>SHALL</strong> support both elements.</li> </ul> </li> <li> <p>When recording “self-prescribed” medication, requester <strong>SHOULD</strong> be used to indicate the Patient or RelatedPerson as the prescriber. (See the Medication List section for guidance on accessing a patient medications including over the counter (OTC) medication and other substances taken for medical and recreational use.)</p> </li> <li> <p>The MedicationRequest resource can communicate the reason or indication for treatment using either a code in MedicationRequest.reasonCode or a reference using MedicationRequest.reasonReference.</p> </li> <li> <p>Although both <code>MedicationRequest.reasonCode</code> and <code>MedicationRequest.reasonReference</code> are marked as Additional USCDI Requirements. The certifying server system is not required to support both but <strong>SHALL</strong> support at least one of these elements. The certifying client application <strong>SHALL</strong> support both elements.</p> <ul> <li>when using MedicationRequest.reasonReference: <ul> <li>Servers <strong>SHALL</strong> support at least one target resource in <code>MedicationRequest.reasonReference</code>. Clients <strong>SHALL</strong> support all target resources.</li> <li>The referenced resources <strong>SHOULD</strong> be a US Core Profile as documented in Referencing US Core Profiles.</li> </ul> </li> </ul> </li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-medicationrequest.html\">US Core MedicationRequest Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a MedicationRequest resource using: <code class=\"highlighter-rouge\">GET [base]/MedicationRequest/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _includes: <ul> <li> MedicationRequest:medication: <code class=\"highlighter-rouge\">GET [base]/MedicationRequest?[parameter=value]&_include=MedicationRequest:medication</code> </li> </ul> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes: Provenance:target - <code class=\"highlighter-rouge\">GET [base]/MedicationRequest?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Combination Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-medicationrequest-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-medicationrequest-intent.html\"> intent</a>+ <a href=\"SearchParameter-us-core-medicationrequest-authoredon.html\"> authoredon</a> </td> <td>reference+token+date </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-medicationrequest-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-medicationrequest-intent.html\"> intent</a>+ <a href=\"SearchParameter-us-core-medicationrequest-status.html\"> status</a> </td> <td>reference+token+token </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-medicationrequest-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-medicationrequest-intent.html\"> intent</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-medicationrequest-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-medicationrequest-intent.html\"> intent</a>+ <a href=\"SearchParameter-us-core-medicationrequest-encounter.html\"> encounter</a> </td> <td>reference+token+reference </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-medicationrequest-authoredon.html\"> authoredon</a> (date):<p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> </li><li><a href=\"SearchParameter-us-core-medicationrequest-encounter.html\"> encounter</a> (reference):<p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-medicationrequest-intent.html\"> intent</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-medicationrequest-patient.html\"> patient</a> (reference):<p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-medicationrequest-status.html\"> status</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li> </ul> </div> <hr/> <h4 id=\"observation\" class=\"no_toc\">Observation</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>Clients <strong>SHALL</strong> support at least one Observation Profile</li> <li>Systems <strong>SHOULD</strong> support <code>Observation.effectivePeriod</code> to accurately represent tests that are collected over a period of time (for example, a 24-Hour Urine Collection test).</li> <li>An Observation without a value, <strong>SHALL</strong> include a reason why the data is absent unless there are component observations, or references to other Observations that are grouped within it <ul> <li>Systems that never provide an observation without a value are not required to support <code>Observation.dataAbsentReason</code></li> </ul> </li> <li>An <code>Observation.component</code> without a value, <strong>SHALL</strong> include a reason why the data is absent. <ul> <li>Systems that never provide an component observation without a component value are not required to support <code>Observation.component.dataAbsentReason</code>.</li> </ul> </li> <li>When <code>Observation.category</code> is "laboratory" the encounter, Updates to Meta.lastUpdated <strong>SHOULD</strong> reflect: <ul> <li>New laboratory results</li> <li>Changes in the status of laboratory results including events that trigger the same status (e.g., amended → amended).</li> </ul> </li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-observation-lab.html\">US Core Laboratory Result Observation Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-observation-pregnancystatus.html\">US Core Observation Pregnancy Status Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-observation-pregnancyintent.html\">US Core Observation Pregnancy Intent Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-observation-occupation.html\">US Core Observation Occupation Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-respiratory-rate.html\">US Core Respiratory Rate Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-simple-observation.html\">US Core Simple Observation Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-treatment-intervention-preference.html\">US Core Treatment Intervention Preference Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-care-experience-preference.html\">US Core Care Experience Preference Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-heart-rate.html\">US Core Heart Rate Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-body-temperature.html\">US Core Body Temperature Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-pediatric-weight-for-height.html\">US Core Pediatric Weight for Height Observation Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-pulse-oximetry.html\">US Core Pulse Oximetry Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-smokingstatus.html\">US Core Smoking Status Observation Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-observation-sexual-orientation.html\">US Core Observation Sexual Orientation Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-head-circumference.html\">US Core Head Circumference Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-body-height.html\">US Core Body Height Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-bmi.html\">US Core BMI Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-observation-screening-assessment.html\">US Core Observation Screening Assessment Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-average-blood-pressure.html\">US Core Average Blood Pressure Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-blood-pressure.html\">US Core Blood Pressure Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-observation-clinical-result.html\">US Core Observation Clinical Result Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-pediatric-bmi-for-age.html\">US Core Pediatric BMI for Age Observation Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-head-occipital-frontal-circumference-percentile.html\">US Core Pediatric Head Occipital Frontal Circumference Percentile Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-body-weight.html\">US Core Body Weight Profile</a> </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-vital-signs.html\">US Core Vital Signs Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a Observation resource using: <code class=\"highlighter-rouge\">GET [base]/Observation/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes: Provenance:target - <code class=\"highlighter-rouge\">GET [base]/Observation?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Combination Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-observation-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-observation-code.html\"> code</a>+ <a href=\"SearchParameter-us-core-observation-date.html\"> date</a> </td> <td>reference+token+date </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-observation-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-observation-category.html\"> category</a>+ <a href=\"SearchParameter-us-core-observation-date.html\"> date</a> </td> <td>reference+token+date </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-observation-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-observation-code.html\"> code</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-observation-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-observation-category.html\"> category</a>+ <a href=\"SearchParameter-us-core-observation-lastupdated.html\"> _lastUpdated</a> </td> <td>reference+token+date </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-observation-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-observation-category.html\"> category</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-observation-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-observation-category.html\"> category</a>+ <a href=\"SearchParameter-us-core-observation-status.html\"> status</a> </td> <td>reference+token+token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-observation-category.html\"> category</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-observation-code.html\"> code</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-observation-date.html\"> date</a> (date):<p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> </li><li><a href=\"SearchParameter-us-core-observation-lastupdated.html\"> _lastUpdated</a> (date):<p>A server <strong>SHALL</strong> document the types of changes that can be detected using this parameter.</p> <p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> </li><li><a href=\"SearchParameter-us-core-observation-patient.html\"> patient</a> (reference):<p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-observation-status.html\"> status</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li> </ul> </div> <hr/> <h4 id=\"organization\" class=\"no_toc\">Organization</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>Systems <strong>SHALL</strong> support National Provider Identifier (NPI) for organizations and <strong>SHOULD</strong> support Clinical Laboratory Improvement Amendments (CLIA) identifiers for <code>Organization.Identifier</code>.</li> <li>Systems <strong>SHOULD</strong> follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for <code>Organization.address.line</code> and <code>Organization.address.city</code>.</li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-organization.html\">US Core Organization Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a Organization resource using: <code class=\"highlighter-rouge\">GET [base]/Organization/[id]</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-organization-address.html\"> address</a> </td> <td> string </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-organization-name.html\"> name</a> </td> <td> string </td> </tr> </tbody> </table> <hr/> <h4 id=\"patient\" class=\"no_toc\">Patient</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li> <p>For ONC's USCDI requirements, each Patient must support the following additional elements. These elements are included in the formal definition of the profile. The patient examples include all of these elements.</p> <ol> <li>contact detail (e.g. a telephone number or an email address)</li> <li>a communication language</li> <li>a race</li> <li>an ethnicity</li> <li>a birth sex*</li> <li>previous name <ul> <li>Previous name is represented by providing an end date in the <code>Patient.name.period</code> element for a previous name.</li> </ul> </li> <li>suffix <ul> <li>Suffix is represented using the <code>Patient.name.suffix</code> element.</li> </ul> </li> </ol> </li> <li> <p>The Patient's Social Security Numbers <strong>SHOULD NOT</strong> be used as a patient identifier in <code>Patient.identifier.value</code>.</p> </li> <li> <p>Although Patient.deceased[x] is marked as 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜, certifying systems are not required to support both choices, but <strong>SHALL</strong> support at least <code>Patient.deceasedDateTime</code>.</p> </li> <li> <p>Certifying systems <strong>SHALL</strong> and non-certifying systems <strong>SHOULD</strong> follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for <code>Patient.address.line</code> and <code>Patient.address.city</code> for new and updated records.</p> </li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-patient.html\">US Core Patient Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a Patient resource using: <code class=\"highlighter-rouge\">GET [base]/Patient/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes: Provenance:target - <code class=\"highlighter-rouge\">GET [base]/Patient?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-patient-id.html\"> _id</a> </td> <td> token </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-patient-identifier.html\"> identifier</a> </td> <td> token </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-patient-name.html\"> name</a> </td> <td> string </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-patient-family.html\"> family</a>+ <a href=\"SearchParameter-us-core-patient-gender.html\"> gender</a> </td> <td>string+token </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-patient-birthdate.html\"> birthdate</a>+ <a href=\"SearchParameter-us-core-patient-name.html\"> name</a> </td> <td>date+string </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-patient-death-date.html\"> death-date</a>+ <a href=\"SearchParameter-us-core-patient-family.html\"> family</a> </td> <td>date+string </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-patient-gender.html\"> gender</a>+ <a href=\"SearchParameter-us-core-patient-name.html\"> name</a> </td> <td>token+string </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-patient-birthdate.html\"> birthdate</a>+ <a href=\"SearchParameter-us-core-patient-family.html\"> family</a> </td> <td>date+string </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-patient-birthdate.html\"> birthdate</a> (date):<p>A client <strong>SHALL</strong> provide a value precise to the <em>day</em>.</p> <p>A server <strong>SHALL</strong> support a value a value precise to the <em>day</em>.</p> </li><li><a href=\"SearchParameter-us-core-patient-death-date.html\"> death-date</a> (date):<p>A client <strong>SHALL</strong> provide a value precise to the <em>day</em>.</p> <p>A server <strong>SHALL</strong> support a value a value precise to the <em>day</em>.</p> </li><li><a href=\"SearchParameter-us-core-patient-family.html\"> family</a> (string):<p>A server <strong>SHALL</strong> support a value precise to the <em>day</em>.</p> </li><li><a href=\"SearchParameter-us-core-patient-gender.html\"> gender</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-patient-identifier.html\"> identifier</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li> </ul> </div> <hr/> <h4 id=\"practitioner\" class=\"no_toc\">Practitioner</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>Servers that support only US Core Practitioner Profile <strong>SHALL</strong> provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource. <ul> <li>Although Practitioner.address is marked as Must Support, the server system is not required to support it if they support the US Core PractitionerRole Profile, but <strong>SHALL</strong> support it if they do not support the US Core PractitionerRole Profile. The client application <strong>SHALL</strong> support both.</li> </ul> </li> <li>Systems <strong>SHOULD</strong> follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for <code>Practitioner.address.line</code> and <code>Practitioner.address.city</code>.</li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-practitioner.html\">US Core Practitioner Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a Practitioner resource using: <code class=\"highlighter-rouge\">GET [base]/Practitioner/[id]</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> </tr> </thead> <tbody><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-practitioner-id.html\"> _id</a> </td> <td> token </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-practitioner-identifier.html\"> identifier</a> </td> <td> token </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-practitioner-name.html\"> name</a> </td> <td> string </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-practitioner-identifier.html\"> identifier</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li> </ul> </div> <hr/> <h4 id=\"practitionerrole\" class=\"no_toc\">PractitionerRole</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>Due to implementer feedback, some US Core Profiles reference the PractitionerRole resource instead of the US Core PractitionerRole Profile. However the US Core PractitionerRole Profile <strong>SHOULD</strong> be used as the default profile if referenced by another US Core profile.</li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-practitionerrole.html\">US Core PractitionerRole Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a PractitionerRole resource using: <code class=\"highlighter-rouge\">GET [base]/PractitionerRole/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _includes: <ul> <li> PractitionerRole:endpoint: <code class=\"highlighter-rouge\">GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:endpoint</code> </li> <li> PractitionerRole:practitioner: <code class=\"highlighter-rouge\">GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:practitioner</code> </li> </ul> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-practitionerrole-practitioner.html\"> practitioner</a> </td> <td> reference </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-practitionerrole-specialty.html\"> specialty</a> </td> <td> token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-practitionerrole-practitioner.html\"> practitioner</a> (reference):<p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-practitionerrole-specialty.html\"> specialty</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li> </ul> </div> <hr/> <h4 id=\"procedure\" class=\"no_toc\">Procedure</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>Procedure codes can be taken from SNOMED-CT, CPT, HCPCS II, ICD-10-PCS, CDT. LOINC. <ul> <li>Only LOINC concepts that reflect actual procedures <strong>SHOULD</strong> be used</li> </ul> </li> <li>A procedure including an implantable device <strong>SHOULD</strong> use <code>Procedure.focalDevice</code> with a reference to the <em>US Core Implantable Device Profile</em>.</li> <li>Servers and Clients <strong>SHALL</strong> support both US Core ServiceRequest and US Core Procedure Profiles for communicating the reason or justification for a referral as Additional USCDI Requirements. Typically, the reason or justification for a referral or consultation is communicated through <code>Procedure.basedOn</code> linking the Procedure to the US Core ServiceRequest Profile that includes either <code>ServiceRequest.reasonCode</code> or <code>ServiceRequest.reasonReference</code>. When the Procedure does not have an associated ServiceRequest, it is communicated through the US Core Procedure Profile's <code>Procedure.reasonCode</code> or <code>Procedure.reasonReference</code>. Depending on the procedure being documented, a server will select the appropriate Profile to use. <ul> <li>Although both <code>Procedure.reasonCode</code> and <code>Procedure.reasonReference</code> are marked as Additional USCDI Requirements. The certifying server system is not required to support both but <strong>SHALL</strong> support at least one of these elements. The certifying client application <strong>SHALL</strong> support both elements. <ul> <li>when using <code>Procedure.reasonReference</code>: <ul> <li>Servers <strong>SHALL</strong> support <em>at least one</em> target resource in <code>Procedure.reasonReference</code>. Clients <strong>SHALL</strong> support all target resources .</li> <li>The referenced resources <strong>SHOULD</strong> be a US Core Profile.</li> </ul> </li> </ul> </li> </ul> </li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-procedure.html\">US Core Procedure Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a Procedure resource using: <code class=\"highlighter-rouge\">GET [base]/Procedure/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes: Provenance:target - <code class=\"highlighter-rouge\">GET [base]/Procedure?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-procedure-patient.html\"> patient</a> </td> <td> reference </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-procedure-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-procedure-status.html\"> status</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-procedure-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-procedure-date.html\"> date</a> </td> <td>reference+date </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-procedure-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-procedure-code.html\"> code</a>+ <a href=\"SearchParameter-us-core-procedure-date.html\"> date</a> </td> <td>reference+token+date </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-procedure-code.html\"> code</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-procedure-date.html\"> date</a> (date):<p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> </li><li><a href=\"SearchParameter-us-core-procedure-patient.html\"> patient</a> (reference):<p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-procedure-status.html\"> status</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li> </ul> </div> <hr/> <h4 id=\"provenance\" class=\"no_toc\">Provenance</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>The US Core Provenance resource <strong>SHALL</strong> be supported for these US Core resources: <ul> <li>AllergyIntolerance</li> <li>CarePlan</li> <li>CareTeam</li> <li>Condition</li> <li>Coverage</li> <li>Device</li> <li>DiagnosticReport</li> <li>DocumentReference</li> <li>Encounter</li> <li>Goal</li> <li>Immunization</li> <li>MedicationDispense</li> <li>MedicationRequest</li> <li>Observation</li> <li>Patient</li> <li>Procedure</li> <li>QuestionnaireResponse</li> <li>RelatedPerson</li> <li>ServiceRequest</li> </ul> </li> <li>If a system receives a provider in <code>Provenance.agent.who</code> as free text they must capture who sent them the information as the organization. On request they <strong>SHALL</strong> provide this organization as the source and <strong>MAY</strong> include the free text provider.</li> <li>Systems that need to know the activity has occurred <strong>SHOULD</strong> populate the activity.</li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-provenance.html\">US Core Provenance Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>search-type</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a Provenance resource using: <code class=\"highlighter-rouge\">GET [base]/Provenance/[id]</code> </li> </ul> <hr/> <h4 id=\"questionnaire\" class=\"no_toc\">Questionnaire</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li> <p>US Core defines two ways to represent the questions and responses to screening and assessment instruments:</p> <ul> <li>Observation: US Core Observation Screening Assessment Profile</li> <li>Questionnaire/QuestionnaireResponse: SDC Base Questionnaire/US Core QuestionnaireResponse Profile</li> </ul> </li> <li> <p>US Core Servers <strong>SHALL</strong> support US Core Observation Screening Assessment Profile and <strong>SHOULD</strong> support the SDC Base Questionnaire Profile/US Core QuestionnaireResponse Profile</p> </li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire\">SDC Base Questionnaire Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>read</code>, <code>vread</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>search-type</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-instance</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHOULD</strong> be capable of fetching a Questionnaire resource using: <code class=\"highlighter-rouge\">GET [base]/Questionnaire/[id]</code> </li> </ul> <hr/> <h4 id=\"questionnaireresponse\" class=\"no_toc\">QuestionnaireResponse</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li> <p>US Core defines two ways to represent the questions and responses to screening and assessment instruments:</p> <ul> <li>Observation: US Core Observation Screening Assessment Profile</li> <li>Questionnaire/QuestionnaireResponse: SDC Base Questionnaire/US Core QuestionnaireResponse Profile</li> </ul> </li> <li> <p>US Core Servers <strong>SHALL</strong> support US Core Observation Screening Assessment Profile and <strong>SHOULD</strong> support the SDC Base Questionnaire Profile/US Core QuestionnaireResponse Profile</p> </li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-questionnaireresponse.html\">US Core QuestionnaireResponse Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHOULD</strong> support <code>search-type</code>, <code>read</code>, <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHOULD</strong> be capable of fetching a QuestionnaireResponse resource using: <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes: Provenance:target - <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-questionnaireresponse-id.html\"> _id</a> </td> <td> token </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-questionnaireresponse-patient.html\"> patient</a> </td> <td> reference </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-questionnaireresponse-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-questionnaireresponse-status.html\"> status</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-questionnaireresponse-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-questionnaireresponse-questionnaire.html\"> questionnaire</a> </td> <td>reference+reference </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-questionnaireresponse-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-questionnaireresponse-authored.html\"> authored</a> </td> <td>reference+date </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-questionnaireresponse-authored.html\"> authored</a> (date):<p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> </li><li><a href=\"SearchParameter-us-core-questionnaireresponse-patient.html\"> patient</a> (reference):<p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-questionnaireresponse-questionnaire.html\"> questionnaire</a> (reference):<p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-questionnaireresponse-status.html\"> status</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li> </ul> </div> <hr/> <h4 id=\"relatedperson\" class=\"no_toc\">RelatedPerson</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>Systems <strong>SHOULD</strong> follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for <code>RelatedPerson.address.line</code> and <code>RelatedPerson.address.city</code>.</li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-relatedperson.html\">US Core RelatedPerson Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a RelatedPerson resource using: <code class=\"highlighter-rouge\">GET [base]/RelatedPerson/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes: Provenance:target - <code class=\"highlighter-rouge\">GET [base]/RelatedPerson?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-relatedperson-id.html\"> _id</a> </td> <td> token </td> </tr><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-relatedperson-name.html\"> name</a> </td> <td> string </td> </tr><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-relatedperson-patient.html\"> patient</a> </td> <td> reference </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-relatedperson-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-relatedperson-name.html\"> name</a> </td> <td>reference+string </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-relatedperson-patient.html\"> patient</a> (reference):<p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li> </ul> </div> <hr/> <h4 id=\"servicerequest\" class=\"no_toc\">ServiceRequest</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>Servers and Clients <strong>SHALL</strong> support both US Core ServiceRequest and US Core Procedure Profiles for communicating the reason or justification for a referral as Additional USCDI Requirements. Typically, the reason or justification for a referral or consultation is communicated through <code>Procedure.basedOn</code> linking the Procedure to the US Core ServiceRequest Profile that includes either <code>ServiceRequest.reasonCode</code> or <code>ServiceRequest.reasonReference</code>. When the Procedure does not have an associated ServiceRequest, it is communicated through the US Core Procedure Profile's <code>Procedure.reasonCode</code> or <code>Procedure.reasonReference</code>. Depending on the procedure being documented, a server will select the appropriate Profile to use. <ul> <li><code>ServiceRequest.reasonCode</code> and <code>ServiceRequest.reasonReference</code> are marked as Additional USCDI Requirements. The certifying server system is not required to support both but <strong>SHALL</strong> support at least one of these elements. The certifying client application <strong>SHALL</strong> support both elements. <ul> <li>when using <code>ServiceRequest.reasonReference</code>: <ul> <li>Servers <strong>SHALL</strong> support <em>at least one</em> target resource in <code>ServiceRequest.reasonReference</code>. Clients <strong>SHALL</strong> support all target resources.</li> <li>The referenced resources <strong>SHOULD</strong> be a US Core Profile.</li> </ul> </li> </ul> </li> </ul> </li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-servicerequest.html\">US Core ServiceRequest Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a ServiceRequest resource using: <code class=\"highlighter-rouge\">GET [base]/ServiceRequest/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes: Provenance:target - <code class=\"highlighter-rouge\">GET [base]/ServiceRequest?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-servicerequest-id.html\"> _id</a> </td> <td> token </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-servicerequest-patient.html\"> patient</a> </td> <td> reference </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-servicerequest-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-servicerequest-status.html\"> status</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-servicerequest-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-servicerequest-code.html\"> code</a>+ <a href=\"SearchParameter-us-core-servicerequest-authored.html\"> authored</a> </td> <td>reference+token+date </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-servicerequest-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-servicerequest-code.html\"> code</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-servicerequest-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-servicerequest-category.html\"> category</a>+ <a href=\"SearchParameter-us-core-servicerequest-authored.html\"> authored</a> </td> <td>reference+token+date </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-servicerequest-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-servicerequest-category.html\"> category</a> </td> <td>reference+token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-servicerequest-authored.html\"> authored</a> (date):<p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> </li><li><a href=\"SearchParameter-us-core-servicerequest-category.html\"> category</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-servicerequest-code.html\"> code</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-servicerequest-patient.html\"> patient</a> (reference):<p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li><li><a href=\"SearchParameter-us-core-servicerequest-status.html\"> status</a> (token):<p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> </li> </ul> </div> <hr/> <h4 id=\"specimen\" class=\"no_toc\">Specimen</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>Although both <code>Specimen.identifier</code> and <code>Specimen.accessionIdentifier</code> are marked as Must Support, the server system is not required to support both, but <strong>SHALL</strong> support at least one of these elements. The client application <strong>SHALL</strong> support both.</li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-specimen.html\">US Core Specimen Profile</a> </li> </ul> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>search-type</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a Specimen resource using: <code class=\"highlighter-rouge\">GET [base]/Specimen/[id]</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-specimen-id.html\"> _id</a> </td> <td> token </td> </tr><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-specimen-patient.html\"> patient</a> </td> <td> reference </td> </tr> </tbody> </table> <hr/> <h4 id=\"valueset\" class=\"no_toc\">ValueSet</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Operation Summary:</p> <ul> <li><strong>SHOULD</strong> support the <a href=\"http://hl7.org/fhir/OperationDefinition/ValueSet-expand\">$expand</a> operation <p>If a server supports DocumentReference for creating, using, and sharing clinical notes, it <strong>SHOULD</strong> also support the <code>context</code> and <code>contextdirection</code> parameters of the $expand operation to enable clients to determine the supported note and report types, as well as the supported read/write formats for notes on the server.</p> </li> </ul> <hr/> </div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cgp"
}
],
"url" : "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client",
"version" : "8.0.0-ballot",
"name" : "UsCoreClientCapabilityStatement",
"title" : "US Core Client CapabilityStatement",
"status" : "active",
"experimental" : false,
"date" : "2024-11-22T13:17:10.631193-08:00",
"publisher" : "HL7 International / Cross-Group Projects",
"contact" : [
{
"name" : "HL7 International / Cross-Group Projects",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/cgp"
},
{
"system" : "email",
"value" : "cgp@lists.HL7.org"
}
]
}
],
"description" : "This Section describes the expected capabilities of the US Core Client which is responsible for creating and initiating the queries for information about an individual patient. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Core Servers are defined in the [Conformance Requirements for Server](CapabilityStatement-us-core-server.html). US Core Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US"
}
]
}
],
"copyright" : "Used by permission of HL7 International, all rights reserved Creative Commons License",
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"json",
"xml"
],
"_format" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"patchFormat" : [
"application/json-patch+json"
],
"_patchFormat" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"implementationGuide" : [
"http://hl7.org/fhir/smart-app-launch/ImplementationGuide/hl7.fhir.uv.smart-app-launch|2.0.0"
],
"_implementationGuide" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"rest" : [
{
"mode" : "client",
"documentation" : "The US Core Client **SHALL**:\n\n1. Support fetching and querying of one or more US Core profile(s), using the supported RESTful interactions and search parameters declared in the US Core Server CapabilityStatement.\n1. Follow the requirements documented in the [General Requirements](general-requirements.html) and [Must Support](must-support.html) pages\n\n**NOTE**: US Core SearchParameters referenced in this CapabilityStatement that are derived from standard FHIR SearchParameters are only defined to document Server and Client expectations. They specify additional expectations for the following SearchParameter elements:\n\n- `multipleAnd`\n- `multipleOr`\n- `comparator`\n- `modifier`\n- `chain`\n\nThey **SHALL NOT** be interpreted as search parameters for search. Servers and Clients **SHOULD** use the standard FHIR SearchParameters.",
"security" : {
"description" : "1. See the [General Security Considerations](security.html) section for requirements and recommendations."
},
"resource" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "clinical-status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "AllergyIntolerance",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance|8.0.0-ballot"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "clinical-status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-clinical-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "status"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "CarePlan",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan|8.0.0-ballot"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* Additional considerations for systems aligning with [HL7 Consolidated (C-CDA)](http://www.hl7.org/implement/standards/product_brief.cfm?product_id=492) Care Plan requirements:\n - US Core Goal **SHOULD** be present in CarePlan.goal\n - US Core Condition **SHOULD** be present in CarePlan.addresses\n - Assessment and Plan **MAY** be included as narrative text",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-category",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-date",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "role"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "CareTeam",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam|8.0.0-ballot"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* In order to access care team member's names, identifiers, locations, and contact information, the CareTeam profile supports several types of care team participants. They are represented as references to other profiles and include the following four profiles which are marked as must support:\n 1. US Core Practitioner Profile\n 1. US Core PractitionerRole Profile\n 1. US Core Patient Profile\n 1. US Core RelatedPerson Profile\n* Although *both* US Core Practitioner Profile and US Core PractitionerRole are must support, the server system is not required to support both types of references, but **SHALL** support *at least* one of them.\n* The client application **SHALL** support all four profile references.\n* Bacause the *US Core PractitionerRole Profile* supplies the provider's location and contact information and a reference to the Practitioner, server systems **SHOULD** reference it instead of the *US Core Practitioner Profile*.\n* Servers that support only US Core Practitioner Profile and do not support the US Core PractitionerRole Profile **SHALL** provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchInclude" : [
"CareTeam:participant:PractitionerRole",
"CareTeam:participant:Practitioner",
"CareTeam:participant:Patient",
"CareTeam:participant:RelatedPerson"
],
"_searchInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-careteam-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "role",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-careteam-role",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-careteam-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "onset-date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "_lastUpdated"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "encounter"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "clinical-status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "recorded-date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "asserted-date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "abatement-date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "code"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "clinical-status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Condition",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns|8.0.0-ballot"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* Clients **SHALL** support at least one Condition Profile\n* For Encounter Diagnosis use the *US Core Condition Encounter Diagnosis Profile*.\n * When `Condition.category` is \"encounter-diagnosis\" the encounter, **SHOULD** be referenced in `Condition.encounter`.\n* For Problems and Health Concerns use the *US Core Condition Problems and Health Concerns Profile*.\n * When `Condition.category` is a \"problems-list-item\", the `Condition.clinicalStatus **SHOULD NOT** be unknown.\n* There is no single element in Condition that represents the date of diagnosis. It may be the assertedDate Extension, `Condition.onsetDateTime`, or `Condition.recordedDate`.\n * Although all three are marked as must support, the server is not required to support all.\n\t* A server **SHALL** support `Condition.recordedDate`.\n * A server **SHALL** support at least one of the assertedDate Extension and `Condition.onsetDateTime`. A server may support both, which means they support all three elements.\n * The client application **SHALL** support all three elements.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "abatement-date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-abatement-date",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "asserted-date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-asserted-date",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-category",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "clinical-status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-clinical-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-code",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "encounter",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-encounter",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "onset-date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-onset-date",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "recorded-date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-recorded-date",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-lastupdated",
"type" : "date",
"documentation" : "A server **SHALL** document the types of changes that can be detected using this parameter.\n\nA client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Coverage",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-coverage|8.0.0-ballot"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-coverage-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "type"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Device",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device|8.0.0-ballot"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* Implantable medical devices that have UDI information **SHALL** represent the UDI code in `Device.udiCarrier.carrierHRF`.\n - All of the five UDI-PI elements that are present in the UDI code **SHALL** be represented in the corresponding US Core Implantable Device Profile element.\n \n UDI may not be present in all scenarios such as historical implantable devices, patient reported implant information, payer reported devices, or improperly documented implants. If UDI is not present and the manufacturer and/or model number information is available, they **SHOULD** be included to support historical reports of implantable medical devices as follows:\n\n manufacturer -> `Device.manufacturer` \n model -> `Device.model` \n\n* Servers **SHOULD** support query by Device.type to allow clients to request the patient's devices by a specific type. Note: The Device.type is too granular to differentiate implantable vs. non-implantable devices.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-device-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-device-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "type",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-device-type",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "code"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "code"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "_lastUpdated"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "DiagnosticReport",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab|8.0.0-ballot"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* Clients **SHALL** support at least one DiagnosticReport Profile\n* When `DiagnosticReport.category` is \"LAB\" the encounter, Updates to Meta.lastUpdated **SHOULD** reflect:\n * New laboratory reports\n * Changes in the status of laboratory reports including events that trigger the same status (e.g., amended → amended).",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "create",
"documentation" : "This conformance expectation applies **only** to the *US Core DiagnosticReport Profile for Report and Note exchange* profile. The conformance expectation for the *US Core DiagnosticReport Profile for Laboratory Results Reporting* is **MAY**."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-category",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-code",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-date",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-lastupdated",
"type" : "date",
"documentation" : "A server **SHALL** document the types of changes that can be detected using this parameter.\n\nA client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "type"
},
{
"url" : "required",
"valueString" : "period"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "type"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "DocumentReference",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference|8.0.0-ballot"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* The `DocumentReference.type` binding **SHALL** support at a minimum the [5 Common Clinical Notes](ValueSet-us-core-clinical-note-type.html) and may extend to the full US Core DocumentReference Type Value Set\n* The DocumentReference resources can represent the referenced content using either an address where the document can be retrieved using `DocumentReference.attachment.url` or the content as inline base64 encoded data using `DocumentReference.attachment.data`.\n * Although both are marked as must support, the server system is not required to support an address, and inline base64 encoded data, but **SHALL** support at least one of these elements.\n * The client application **SHALL** support both elements.\n * The `content.url` may refer to a FHIR Binary Resource (i.e. [base]/Binary/[id]), FHIR Document Bundle (i.e [base]/Bundle/[id] or another endpoint.\n * If the endpoint is outside the FHIR base URL, it **SHOULD NOT** require additional authorization to access.\n * If there are multiple `DocumentReference.content` element repetitions, these **SHALL** all represent the same document in different format or attachment metadata. The content element **SHALL NOT** contain different versions of the same content. For version handling use multiple DocumentReferences with `DocumentReference.relatesTo`\n* Every DocumentReference must have a responsible Organization. The organization responsible for the DocumentReference **SHALL** be present either in `DocumentReference.custodian` or accessible in the Provenance resource targeting the DocumentReference using `Provenance.agent.who` or `Provenance.agent.onBehalfOf`.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
&nbs " : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Medication",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication|8.0.0-ballot"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* The MedicationRequest resource can represent a medication, using an external reference to a Medication resource. If an external Medication Resource is used in a MedicationRequest, then the READ **SHALL** be supported.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "status"
},
{
"url" : "required",
"valueString" : "type"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "MedicationDispense",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationdispense|8.0.0-ballot"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* The MedicationDispense resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be [contained](http://hl7.org/fhir/R4/references.html#contained) or an external resource. The server application **MAY** choose any one way or more than one method, but if an external reference to Medication is used, the server **SHALL** support the _include` parameter for searching this element. The client application must support all methods.\n * For example, A server **SHALL** be capable of returning dispense records for all medications for a patient using one of or both:\n * `GET /MedicationDispense?patient=[id]`\n * `GET /MedicationDispense?patient=[id]&_include=MedicationDispense:medication`\n",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchInclude" : [
"MedicationDispense:medication"
],
"_searchInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationdispense-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationdispense-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "type",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationdispense-type",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "intent"
},
{
"url" : "required",
"valueString" : "authoredon"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "intent"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "intent"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "intent"
},
{
"url" : "required",
"valueString" : "encounter"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "MedicationRequest",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest|8.0.0-ballot"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* The MedicationRequest resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be [contained](http://hl7.org/fhir/R4/references.html#contained) or an external resource. The server application **MAY** choose any one way or more than one method, but if an external reference to Medication is used, the server **SHALL** support the _include` parameter for searching this element. The client application must support all methods.\n * For example, A server **SHALL** be capable of returning all medications for a patient using one of or both:\n * `GET /MedicationRequest?patient=[id]`\n * `GET /MedicationRequest?patient=[id]&_include=MedicationRequest:medication`\n\n* The MedicationRequest resource can represent that information is from a secondary source using either a boolean flag or reference in `MedicationRequest.reportedBoolean`, or a reference using `MedicationRequest.reportedReference` to Practitioner or other resource.\n * Although both are marked as must support, the server systems are not required to support both a boolean and a reference, but **SHALL** choose to support at least one of these elements.\n * The client application **SHALL** support both elements.\n\n* When recording “self-prescribed” medication, requester **SHOULD** be used to indicate the Patient or RelatedPerson as the prescriber. (See the Medication List section for guidance on accessing a patient medications including over the counter (OTC) medication and other substances taken for medical and recreational use.)\n\n* The MedicationRequest resource can communicate the reason or indication for treatment using either a code in MedicationRequest.reasonCode or a reference using MedicationRequest.reasonReference.\n\n* Although both `MedicationRequest.reasonCode` and `MedicationRequest.reasonReference` are marked as Additional USCDI Requirements. The certifying server system is not required to support both but **SHALL** support at least one of these elements. The certifying client application **SHALL** support both elements.\n * when using MedicationRequest.reasonReference:\n * Servers **SHALL** support at least one target resource in `MedicationRequest.reasonReference`. Clients **SHALL** support all target resources.\n * The referenced resources **SHOULD** be a US Core Profile as documented in Referencing US Core Profiles.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchInclude" : [
"MedicationRequest:medication"
],
"_searchInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "authoredon",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-authoredon",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "encounter",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-encounter",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "intent",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-intent",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "code"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "code"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "_lastUpdated"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Observation",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-pregnancystatus|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-pregnancyintent|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-occupation|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-respiratory-rate|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-simple-observation|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-treatment-intervention-preference|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-care-experience-preference|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-heart-rate|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-temperature|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-sexual-orientation|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-head-circumference|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-height|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-bmi|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-screening-assessment|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-average-blood-pressure|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-blood-pressure|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-clinical-result|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-weight|8.0.0-ballot",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs|8.0.0-ballot"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* Clients **SHALL** support at least one Observation Profile\n* Systems **SHOULD** support `Observation.effectivePeriod` to accurately represent tests that are collected over a period of time (for example, a 24-Hour Urine Collection test).\n* An Observation without a value, **SHALL** include a reason why the data is absent unless there are component observations, or references to other Observations that are grouped within it\n * Systems that never provide an observation without a value are not required to support `Observation.dataAbsentReason`\n* An `Observation.component` without a value, **SHALL** include a reason why the data is absent.\n * Systems that never provide an component observation without a component value are not required to support `Observation.component.dataAbsentReason`.\n* When `Observation.category` is \"laboratory\" the encounter, Updates to Meta.lastUpdated **SHOULD** reflect:\n * New laboratory results\n * Changes in the status of laboratory results including events that trigger the same status (e.g., amended → amended).\n\n\n",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-category",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-code",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-date",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-lastupdated",
"type" : "date",
"documentation" : "A server **SHALL** document the types of changes that can be detected using this parameter.\n\nA client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Organization",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization|8.0.0-ballot"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* Systems **SHALL** support National Provider Identifier (NPI) for organizations and **SHOULD** support Clinical Laboratory Improvement Amendments (CLIA) identifiers for `Organization.Identifier`.\n* Systems **SHOULD** follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for `Organization.address.line` and `Organization.address.city`.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "address",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-organization-address",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-organization-name",
"type" : "string"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "family"
},
{
"url" : "required",
"valueString" : "gender"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "birthdate"
},
{
"url" : "required",
"valueString" : "name"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "death-date"
},
{
"url" : "required",
"valueString" : "family"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "gender"
},
{
"url" : "required",
"valueString" : "name"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "birthdate"
},
{
"url" : "required",
"valueString" : "family"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Patient",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|8.0.0-ballot"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* For ONC's USCDI requirements, each Patient must support the following additional elements. These elements are included in the formal definition of the profile. The patient examples include all of these elements.\n\n 1. contact detail (e.g. a telephone number or an email address)\n 1. a communication language\n 1. a race\n 1. an ethnicity\n 1. a birth sex*\n 1. previous name\n - Previous name is represented by providing an end date in the `Patient.name.period` element for a previous name.\n 1. suffix\n - Suffix is represented using the `Patient.name.suffix` element.\n* The Patient's Social Security Numbers **SHOULD NOT** be used as a patient identifier in `Patient.identifier.value`.\n* Although Patient.deceased[x] is marked as 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜, certifying systems are not required to support both choices, but **SHALL** support at least `Patient.deceasedDateTime`.\n* Certifying systems **SHALL** and non-certifying systems **SHOULD** follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for `Patient.address.line` and `Patient.address.city` for new and updated records.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-id",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "birthdate",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *day*.\n\nA server **SHALL** support a value a value precise to the *day*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "death-date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-death-date",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *day*.\n\nA server **SHALL** support a value a value precise to the *day*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "family",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family",
"type" : "string",
"documentation" : "A server **SHALL** support a value precise to the *day*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "gender",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-gender",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "given",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-given",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-identifier",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-name",
"type" : "string"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Practitioner",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|8.0.0-ballot"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* Servers that support only US Core Practitioner Profile **SHALL** provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource.\n * Although Practitioner.address is marked as Must Support, the server system is not required to support it if they support the US Core PractitionerRole Profile, but **SHALL** support it if they do not support the US Core PractitionerRole Profile. The client application **SHALL** support both.\n* Systems **SHOULD** follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for `Practitioner.address.line` and `Practitioner.address.city`.\n",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-id",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-identifier",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-name",
"type" : "string"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "PractitionerRole",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole|8.0.0-ballot"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* Due to implementer feedback, some US Core Profiles reference the PractitionerRole resource instead of the US Core PractitionerRole Profile. However the US Core PractitionerRole Profile **SHOULD** be used as the default profile if referenced by another US Core profile.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchInclude" : [
"PractitionerRole:endpoint",
"PractitionerRole:practitioner"
],
"_searchInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "practitioner",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitionerrole-practitioner",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "specialty",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitionerrole-specialty",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "code"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Procedure",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure|8.0.0-ballot"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* Procedure codes can be taken from SNOMED-CT, CPT, HCPCS II, ICD-10-PCS, CDT. LOINC.\n * Only LOINC concepts that reflect actual procedures **SHOULD** be used\n* A procedure including an implantable device **SHOULD** use `Procedure.focalDevice` with a reference to the *US Core Implantable Device Profile*.\n* Servers and Clients **SHALL** support both US Core ServiceRequest and US Core Procedure Profiles for communicating the reason or justification for a referral as Additional USCDI Requirements. Typically, the reason or justification for a referral or consultation is communicated through `Procedure.basedOn` linking the Procedure to the US Core ServiceRequest Profile that includes either `ServiceRequest.reasonCode` or `ServiceRequest.reasonReference`. When the Procedure does not have an associated ServiceRequest, it is communicated through the US Core Procedure Profile's `Procedure.reasonCode` or `Procedure.reasonReference`. Depending on the procedure being documented, a server will select the appropriate Profile to use.\n * Although both `Procedure.reasonCode` and `Procedure.reasonReference` are marked as Additional USCDI Requirements. The certifying server system is not required to support both but **SHALL** support at least one of these elements. The certifying client application **SHALL** support both elements.\n * when using `Procedure.reasonReference`:\n * Servers **SHALL** support *at least one* target resource in `Procedure.reasonReference`. Clients **SHALL** support all target resources .\n * The referenced resources **SHOULD** be a US Core Profile.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-code",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-date",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Provenance",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance|8.0.0-ballot"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* The US Core Provenance resource **SHALL** be supported for these US Core resources:\n * AllergyIntolerance\n * CarePlan\n * CareTeam\n * Condition\n * Coverage\n * Device\n * DiagnosticReport\n * DocumentReference\n * Encounter\n * Goal\n * Immunization\n * MedicationDispense\n * MedicationRequest\n * Observation\n * Patient\n * Procedure\n * QuestionnaireResponse\n * RelatedPerson\n * ServiceRequest\n* If a system receives a provider in `Provenance.agent.who` as free text they must capture who sent them the information as the organization. On request they **SHALL** provide this organization as the source and **MAY** include the free text provider.\n* Systems that need to know the activity has occurred **SHOULD** populate the activity.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Questionnaire",
"supportedProfile" : [
"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* US Core defines two ways to represent the questions and responses to screening and assessment instruments:\n\n - Observation: US Core Observation Screening Assessment Profile\n - Questionnaire/QuestionnaireResponse: SDC Base Questionnaire/US Core QuestionnaireResponse Profile\n\n* US Core Servers **SHALL** support US Core Observation Screening Assessment Profile and **SHOULD** support the SDC Base Questionnaire Profile/US Core QuestionnaireResponse Profile",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "questionnaire"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "authored"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "QuestionnaireResponse",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-questionnaireresponse|8.0.0-ballot"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* US Core defines two ways to represent the questions and responses to screening and assessment instruments:\n\n - Observation: US Core Observation Screening Assessment Profile\n - Questionnaire/QuestionnaireResponse: SDC Base Questionnaire/US Core QuestionnaireResponse Profile\n\n* US Core Servers **SHALL** support US Core Observation Screening Assessment Profile and **SHOULD** support the SDC Base Questionnaire Profile/US Core QuestionnaireResponse Profile",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-questionnaireresponse-id",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "authored",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-questionnaireresponse-authored",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-questionnaireresponse-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "questionnaire",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-questionnaireresponse-questionnaire",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-questionnaireresponse-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "name"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "RelatedPerson",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson|8.0.0-ballot"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* Systems **SHOULD** follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for `RelatedPerson.address.line` and `RelatedPerson.address.city`.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-relatedperson-id",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-relatedperson-name",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-relatedperson-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "code"
},
{
"url" : "required",
"valueString" : "authored"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "code"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "authored"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "ServiceRequest",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-servicerequest|8.0.0-ballot"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* Servers and Clients **SHALL** support both US Core ServiceRequest and US Core Procedure Profiles for communicating the reason or justification for a referral as Additional USCDI Requirements. Typically, the reason or justification for a referral or consultation is communicated through `Procedure.basedOn` linking the Procedure to the US Core ServiceRequest Profile that includes either `ServiceRequest.reasonCode` or `ServiceRequest.reasonReference`. When the Procedure does not have an associated ServiceRequest, it is communicated through the US Core Procedure Profile's `Procedure.reasonCode` or `Procedure.reasonReference`. Depending on the procedure being documented, a server will select the appropriate Profile to use.\n * `ServiceRequest.reasonCode` and `ServiceRequest.reasonReference` are marked as Additional USCDI Requirements. The certifying server system is not required to support both but **SHALL** support at least one of these elements. The certifying client application **SHALL** support both elements.\n * when using `ServiceRequest.reasonReference`:\n * Servers **SHALL** support *at least one* target resource in `ServiceRequest.reasonReference`. Clients **SHALL** support all target resources.\n * The referenced resources **SHOULD** be a US Core Profile.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-servicerequest-id",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "authored",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-servicerequest-authored",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-servicerequest-category",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-servicerequest-code",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-servicerequest-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-servicerequest-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Specimen",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen|8.0.0-ballot"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* Although both `Specimen.identifier` and `Specimen.accessionIdentifier` are marked as Must Support, the server system is not required to support both, but **SHALL** support at least one of these elements. The client application **SHALL** support both.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-specimen-id",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-specimen-patient",
"type" : "reference"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "ValueSet",
"operation" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "expand",
"definition" : "http://hl7.org/fhir/OperationDefinition/ValueSet-expand",
"documentation" : "If a server supports DocumentReference for creating, using, and sharing clinical notes, it **SHOULD** also support the `context` and `contextdirection` parameters of the $expand operation to enable clients to determine the supported note and report types, as well as the supported read/write formats for notes on the server."
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "transaction"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "batch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-system"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-system"
}
]
}
]
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.